docs(): update readme

pull/45/head
Magicalex 2019-11-28 14:56:30 +01:00
parent d617fa5507
commit 6c81a8faea
No known key found for this signature in database
GPG Key ID: A89B48B1788C3CB5
1 changed files with 21 additions and 7 deletions

View File

@ -15,13 +15,13 @@ Simple forum software for building great communities. https://flarum.org/
- Lightweight & secure image - Lightweight & secure image
- Based on Alpine Linux with **nginx** and **PHP 7.3** - Based on Alpine Linux with **nginx** and **PHP 7.3**
- Latest [Flarum Core](https://github.com/flarum/core) (v0.1.0-beta.10) - Latest [Flarum Core](https://github.com/flarum/core) (v0.1.0-beta.11)
- MySQL/Mariadb driver - MySQL/Mariadb driver
- OPCache extension configured - OPCache extension configured
### Build-time variables ### Build-time variables
- **VERSION** = Version of [flarum/flarum](https://github.com/flarum/flarum) skeleton (default: *v0.1.0-beta.10*) - **VERSION** = Version of [flarum/flarum](https://github.com/flarum/flarum) skeleton (default: *v0.1.0-beta.11*)
### Ports ### Ports
@ -51,7 +51,7 @@ Simple forum software for building great communities. https://flarum.org/
| **PHP_MEMORY_LIMIT** | PHP memory limit | *optional* | 128M | | **PHP_MEMORY_LIMIT** | PHP memory limit | *optional* | 128M |
| **OPCACHE_MEMORY_LIMIT** | OPcache memory size in megabytes | *optional* | 128 | **OPCACHE_MEMORY_LIMIT** | OPcache memory size in megabytes | *optional* | 128
| **LOG_TO_STDOUT** | Enable nginx and php error logs to stdout | *optional* | false | **LOG_TO_STDOUT** | Enable nginx and php error logs to stdout | *optional* | false
| **GITHUB_TOKEN_AUTH** | github token to download private extensions | *optional* | false | **GITHUB_TOKEN_AUTH** | Github token to download private extensions | *optional* | false
### Required environment variable for first installation ### Required environment variable for first installation
@ -68,7 +68,7 @@ Simple forum software for building great communities. https://flarum.org/
```bash ```bash
# Pull from hub.docker.com : # Pull from hub.docker.com :
docker pull mondedie/docker-flarum:0.1.0-beta.10-stable docker pull mondedie/docker-flarum:0.1.0-beta.11-stable
# or build it manually : # or build it manually :
docker build -t mondedie/docker-flarum https://github.com/mondediefr/flarum.git#master docker build -t mondedie/docker-flarum https://github.com/mondediefr/flarum.git#master
@ -81,7 +81,7 @@ version: "3"
services: services:
flarum: flarum:
image: mondedie/docker-flarum:0.1.0-beta.10-stable image: mondedie/docker-flarum:0.1.0-beta.11-stable
container_name: flarum container_name: flarum
env_file: env_file:
- /mnt/docker/flarum/flarum.env - /mnt/docker/flarum/flarum.env
@ -135,7 +135,9 @@ FLARUM_TITLE=Test flarum
Run your docker-compose Run your docker-compose
```sh ```sh
docker-compose up -d docker-compose up -d mariadb
# Wait a moment for the creation of the database
docker-compose up -d flarum
``` ```
* :warning: Your admin password must contain at least **8 characters** (FLARUM_ADMIN_PASS). * :warning: Your admin password must contain at least **8 characters** (FLARUM_ADMIN_PASS).
@ -212,9 +214,21 @@ https://getcomposer.org/doc/03-cli.md#modifying-repositories
```sh ```sh
docker pull mondedie/docker-flarum:0.1.0-beta.11-stable docker pull mondedie/docker-flarum:0.1.0-beta.11-stable
```
Update your docker-compose.yml file
```yml
version: "3"
services:
flarum:
image: mondedie/docker-flarum:0.1.0-beta.11-stable
```
```sh
docker-compose stop flarum docker-compose stop flarum
docker-compose rm flarum docker-compose rm flarum
docker-compose up -d docker-compose up -d flarum
``` ```
3 - Updating your database and removing old assets: 3 - Updating your database and removing old assets: