Merge pull request #6707 from opf/feature/release-8-docs-updates

release 8 docs updates
pull/6713/head
Markus Kahl 6 years ago committed by GitHub
commit 1619bdc938
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 8
      docs/installation/docker/README.md
  2. 11
      docs/installation/manual/README.md
  3. 2
      docs/installation/packaged/4-faq.md
  4. 2
      docs/installation/packaged/sles-11/README.md
  5. 2
      docs/installation/packaged/sles-12/README.md
  6. 2
      docs/installation/packaged/ubuntu-14.04/README.md
  7. 2
      docs/installation/packaged/ubuntu-16.04/README.md
  8. 3
      docs/operations/backup/docker/backup.md
  9. 3
      docs/operations/upgrading/manual/upgrading.md

@ -19,7 +19,7 @@ the options that the package-based or manual installation provides.
The fastest way to get an OpenProject instance up and running is to run the
following command:
docker run -it -p 8080:80 -e SECRET_KEY_BASE=secret openproject/community:7
docker run -it -p 8080:80 -e SECRET_KEY_BASE=secret openproject/community:8
This will take a bit of time the first time you launch it, but after a few
minutes you should see a success message indicating the default administration
@ -35,7 +35,7 @@ the logs to your terminal, which helps with debugging if anything goes wrong.
For normal usage you probably want to start it in the background, which can be
achieved with the `-d` flag:
docker run -d -p 8080:80 -e SECRET_KEY_BASE=secret openproject/community:7
docker run -d -p 8080:80 -e SECRET_KEY_BASE=secret openproject/community:8
### Recommended usage
@ -58,7 +58,7 @@ those directories mounted:
-v /var/lib/openproject/pgdata:/var/lib/postgresql/9.6/main \
-v /var/lib/openproject/logs:/var/log/supervisor \
-v /var/lib/openproject/static:/var/db/openproject \
openproject/community:7
openproject/community:8
Since we named the container, you can now stop it by running:
@ -143,7 +143,7 @@ Yes. You can simply pass a custom `DATABASE_URL` environment variable on the
command-line, which could point to an external database. You can even choose to
use MySQL instead of PostgreSQL if you wish. Here is how you would do it:
docker run -d ... -e DATABASE_URL=mysql2://user:pass@host:port/dbname openproject/community:7
docker run -d ... -e DATABASE_URL=mysql2://user:pass@host:port/dbname openproject/community:8
The container will make sure that the database gets the migrations and demo
data as well.

@ -63,7 +63,7 @@ sudo passwd openproject #(enter desired password)
We recommend to use the latest MySQL version (>= 5.7) as it supports
special charachters such as emojis (emoticons) out of the box.
If your Linux distribution only provides older versions of MySQL it is worth considering
If your Linux distribution only provides older versions of MySQL it is worth considering
[adding MySQL as an `apt` source](https://dev.mysql.com/doc/mysql-apt-repo-quick-guide/en/).
Once you have your `apt` sources nicely set up install the packages.
@ -94,8 +94,8 @@ mysql> CREATE DATABASE openproject CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode
**On MySQL version 5.6 or older (not recommended)**
(!!) No support for emojis (emoticons). See above! If you have to use
5.6 or older and you need to support special unicode characters you can
get there but we don't provide the instructions here as it would bloat
5.6 or older and you need to support special unicode characters you can
get there but we don't provide the instructions here as it would bloat
this manual.
```sql
@ -173,7 +173,7 @@ with OpenProject. For more information, see https://github.com/opf/openproject-c
```bash
[openproject@host] cd ~
[openproject@host] git clone https://github.com/opf/openproject-ce.git --branch stable/7 --depth 1
[openproject@host] git clone https://github.com/opf/openproject-ce.git --branch stable/8 --depth 1
[openproject@host] cd openproject-ce
[openproject@host] gem install bundler
[openproject@host] bundle install --deployment --without postgres sqlite development test therubyracer docker
@ -196,7 +196,7 @@ you used above: user, database and password):
**On MySQL version 5.7 or greater (recommended)**
The encoding should be set to `utf8mb4` as we created the DB with that encoding
a few steps ago.
a few steps ago.
```yaml
production:
@ -531,4 +531,3 @@ If you need to restart the server (for example after a configuration change), do
If you have any further questions, comments, feedback, or an idea to enhance this guide, please tell us at the appropriate community [forum](https://community.openproject.org/projects/openproject/boards/9).
[Follow OpenProject on twitter](https://twitter.com/openproject), and follow the news on [openproject.org](http://openproject.org) to stay up to date.

@ -75,7 +75,7 @@ Here is how you do it using [certbot](https://github.com/certbot/certbot):
curl https://dl.eff.org/certbot-auto > /usr/local/bin/certbot-auto
chmod a+x /usr/local/bin/certbot-auto
certbot-auto certonly --webroot --webroot-path /opt/openproject/public -d openprojecct.mydomain.com
This requires your OpenProject server to be available from the Internet on port 443 or 80.

@ -6,7 +6,7 @@ All steps need to be run as `root`.
```
wget -O /etc/zypp/repos.d/openproject-ce.repo \
https://dl.packager.io/srv/opf/openproject-ce/stable/7/installer/sles/11.repo
https://dl.packager.io/srv/opf/openproject-ce/stable/8/installer/sles/11.repo
```
The package source is now registered as `openproject`.

@ -6,7 +6,7 @@ All steps need to be run as `root`.
```
wget -O /etc/zypp/repos.d/openproject-ce.repo \
https://dl.packager.io/srv/opf/openproject-ce/stable/7/installer/sles/12.repo
https://dl.packager.io/srv/opf/openproject-ce/stable/8/installer/sles/12.repo
```
The package source is now registered as `openproject`.

@ -18,7 +18,7 @@ Our repository requires apt to have https support. Install this transport method
```
sudo wget -O /etc/apt/sources.list.d/openproject-ce.list \
https://dl.packager.io/srv/opf/openproject-ce/stable/7/installer/ubuntu/14.04.repo
https://dl.packager.io/srv/opf/openproject-ce/stable/8/installer/ubuntu/14.04.repo
```
**4. Install the OpenProject Community Edition package**

@ -18,7 +18,7 @@ Our repository requires apt to have https support. Install this transport method
```
sudo wget -O /etc/apt/sources.list.d/openproject-ce.list \
https://dl.packager.io/srv/opf/openproject-ce/stable/7/installer/ubuntu/16.04.repo
https://dl.packager.io/srv/opf/openproject-ce/stable/8/installer/ubuntu/16.04.repo
```

@ -13,7 +13,7 @@ with Docker:
-v /var/lib/openproject/pgdata:/var/lib/postgresql/9.6/main \
-v /var/lib/openproject/logs:/var/log/supervisor \
-v /var/lib/openproject/static:/var/db/openproject \
openproject/community:7.0
openproject/community:8
If you're using the same local directories than the above command, then you
just need to backup your local `/var/lib/openproject` folder (for instance to
@ -21,4 +21,3 @@ S3 or FTP).
If at any point you want to restore from a backup, just put your backup in
`/var/lib/openproject` on your local host, and re-launch the docker container.

@ -49,8 +49,6 @@ OpenProject 8.0. uses Angular for the majority of the frontend application. The
MySQL 8.0. removes the deprecated SQL mode `no_auto_create_user` that we enforced up until 7.4. You will need to remove this mode from your `config/database.yml` should you have used it. For more information, see https://community.openproject.com/wp/28524
# OpenProject 6.x to OpenProject 7.x Debian/Ubuntu Upgrade Guide (Manual installation)
Please look at the steps in the section about the upgrade to OpenProject 6.0. OpenProject 7.x is being released under the branch `stable/7`. The other steps are identical.
@ -302,4 +300,3 @@ run:
If you have any further questions, comments, feedback, or an idea to enhance this guide, please tell us at the appropriate forum.
Also, please take a look at the Frequently [Asked Questions](https://www.openproject.org/help/faq/).

Loading…
Cancel
Save