From 8df49feaf888f747859dd8915d53c9b4edead2e6 Mon Sep 17 00:00:00 2001 From: Ween Jiann Date: Mon, 29 Mar 2021 00:54:57 +0800 Subject: [PATCH] Update README.md --- README.md | 35 +++++++++++++++++++---------------- 1 file changed, 19 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 6ee23f0..9ba863e 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ git clone https://github.com/invoiceninja/dockerfiles.git cd dockerfiles ``` -Instead of defining our environment variables inside our docker-compose.yml file we now define this in the ```env``` file, open this file up and insert your APP_URL and your APP_KEY +Instead of defining our environment variables inside our docker-compose.yml file we now define this in the `env` file, open this file up and insert your `APP_URL` and your `APP_KEY` ``` APP_URL=http://in.localhost:8003/ @@ -39,32 +39,23 @@ DB_DATABASE1=ninja PHANTOMJS_PDF_GENERATION=false ``` -The ```APP_KEY``` can be generated by running +The `APP_KEY` can be generated by running -``` +```bash docker run --rm -it invoiceninja/invoiceninja php artisan key:generate --show ``` -Copy the entire string and insert in the env file at ```APP_KEY=base64....``` +Copy the entire string and insert in the env file at `APP_KEY=base64....` -To ensure folder permissions are correct when the container comes up for the first time it is important that you set the correct folder permissions on the ```docker``` folder. +To ensure folder permissions are correct when the container comes up for the first time it is important that you set the correct folder permissions on the `docker` folder. From the terminal run -```sudo chown -R 1500:1500 docker/app``` - -## Updating the image when using `docker-compose` - -As `docker-compose` does not support any form of version control, this git provide updates to `docker-compose.yml` directly. - -To upgrade to a newer release image, please make sure to update the `docker-compose.yml` first by running - ```bash -git pull +chmod 755 docker/app/public +sudo chown -R 1500:1500 docker/app ``` -You may need to manually merge any changes that cannot be merged automatically by git. - ### Note for people running the container locally on their PC ### If you are running the container locally, then the container will need to resolve the host, to support this you will want to insert your LAN IP address and the host name in the hosts file located in ```config/hosts``` @@ -84,6 +75,18 @@ All that is left to do now is bring up the container **Note: When performing the setup, the Database host is ```db``` +## Updating the Image when using `docker-compose` + +As `docker-compose` does not support any form of version control, this git provide updates to `docker-compose.yml` directly. + +To upgrade to a newer release image, please make sure to update the `docker-compose.yml` first by running + +```bash +git pull +``` + +You may need to manually merge any changes that cannot be merged automatically by git. + ## Support If you discover a bug, please create and issue, if you query is general in nature please visit us on our [Forum ](https://forum.invoiceninja.com/)