Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
return wrong replacements
  • Loading branch information
gschwend authored Aug 13, 2024
1 parent b8b6cc0 commit 6ba2ca8
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ git clone https://github.com/linea-it/pzserver_app.git
cd pzserver_app
```

Copy the file `docker compose-development.yml` and rename to `docker compose.yml`
Copy the file `docker-compose-development.yml` and rename to `docker-compose.yml`

```bash
cp docker compose-development.yml docker compose.yml
cp docker-compose-development.yml docker-compose.yml
```

Create the environment variables file based on `env_template`.
Expand All @@ -34,7 +34,7 @@ Check your linux user id with:
```bash
echo $UID
```
and update it in the `docker compose.yml` file if necessary (if it is not the usual 1000).
and update it in the `docker-compose.yml` file if necessary (if it is not the usual 1000).

Now start the database service. It is important that the first time the database service is turned on alone, in this step postgresql will create the database and the user based on the settings `POSTGRES_USER`, `POSTGRES_PASSWORD` and `POSTGRES_DB`.

Expand Down Expand Up @@ -95,7 +95,7 @@ This command will create the directory `pzserver/frontend/node_modules` if you h

In the development environment it is not necessary to change Ngnix settings.
But if a local change is needed, copy the `nginx_development.conf` file to `nginx.conf`
Also change the `docker compose.yml` file in the ngnix service at the line `- ./nginx_development.conf:/etc/nginx/conf.d/default.conf:ro`. In this way, the ngnix.conf file represents your local environment, if you make any modifications that are necessary for the project, copy this modification to the template file, as the nginx.conf file is not part of the repository.
Also change the `docker-compose.yml` file in the ngnix service at the line `- ./nginx_development.conf:/etc/nginx/conf.d/default.conf:ro`. In this way, the ngnix.conf file represents your local environment, if you make any modifications that are necessary for the project, copy this modification to the template file, as the nginx.conf file is not part of the repository.

Finally, to start the whole application:

Expand Down Expand Up @@ -132,7 +132,7 @@ mkdir orchestration/db orchestration/logs orchestration/processes
```

``` bash
cp docker compose-development-orch.yml docker compose.yml
cp docker-compose-development-orch.yml docker-compose.yml
docker network create orchestration-network # create internal network
```

Expand Down Expand Up @@ -310,7 +310,7 @@ cp pz.key pzkey.pem
cp pz.crt pzcert.pem
```

Next we must uncomment the volume that represents the saml2 directory in docker compose.yml:
Next we must uncomment the volume that represents the saml2 directory in docker-compose.yml:

```yml
- ./archive/log/backend:/archive/log
Expand Down Expand Up @@ -347,7 +347,7 @@ The following example assumes an installation where the database and ngnix are i
Only:

- create the folders
- create `docker compose.yml` file
- create `docker-compose.yml` file
- create `.env` file
- create `ngnix.conf` file

Expand All @@ -358,7 +358,7 @@ mkdir pzserver pzserver/archive pzserver/archive/data pzserver/archive/django_st
cd pzserver
```

Create a `docker compose.yml` file based on the `docker compose-production.yml` template
Create a `docker-compose.yml` file based on the `docker-compose-production.yml` template

Change the frontend and backend images to the desired version, replace the string `<VERSION>` with the image tag.

Expand Down Expand Up @@ -404,12 +404,12 @@ Start all services
docker compose up -d
```

Configure a URL that points to the machine where it is installed on the port configured for Ngnix in docker compose.
Configure a URL that points to the machine where it is installed on the port configured for Ngnix in docker-compose.

At the end of this example the pzserver folder looks like this:

```bash
-rw-r--r-- docker compose.yml
-rw-r--r-- docker-compose.yml
-rw-r--r-- nginx.conf # Ngnix configuration file.
-rw-r--r-- .env # File with configuration variables
drwxr-xr-x archive # Directory where the files generated by the application are kept.
Expand All @@ -421,7 +421,7 @@ drwxr-xr-x pg_backups # Directory where postgresql files are in container

Procedure to update the production environment or any other that uses built images.

- Edit the `docker compose.yml` file and change the frontend and backend images tag.
- Edit the `docker-compose.yml` file and change the frontend and backend images tag.
- Edit the `.env` file to add new variables or change them if necessary.
- Pull the new images with the `docker compose pull` command.
- Restart services `docker compose stop && docker compose up -d`.
Expand Down

0 comments on commit 6ba2ca8

Please sign in to comment.