You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,25 +44,25 @@ DEBUG=(True|False)
44
44
## Deploy using Docker Compose
45
45
The following commands should get everything up and running, using the web based version of the MVS API.
46
46
47
-
You need to be able to run docker-compose inside your terminal. If you can't you should install [Docker desktop](https://www.docker.com/products/docker-desktop/) first.
47
+
You need to be able to run docker-compose inside your terminal. If you can't you should install [Docker desktop](https://www.docker.com/products/docker-desktop/) first.
48
48
49
49
50
50
* Clone the repository locally `git clone --single-branch --branch main https://github.com/open-plan-tool/gui.git open_plan_gui`
51
51
* Move inside the created folder (`cd open_plan_gui`)
52
52
* Edit the `.envs/epa.postgres` and `.envs/db.postgres` environment files
53
53
* Change the value assigned to `EPA_SECRET_KEY` with a [randomly generated one](https://randomkeygen.com/)
54
54
* Make sure to replace dummy names with you preferred names
55
-
* The value assigned to the variables `POSTGRES_DB`, `POSTGRES_USER`, `POSTGRES_PASSWORD` in `.envs/db.postgres` should match the ones of
55
+
* The value assigned to the variables `POSTGRES_DB`, `POSTGRES_USER`, `POSTGRES_PASSWORD` in `.envs/db.postgres` should match the ones of
56
56
the variables `SQL_DATABASE`, `SQL_USER`, `SQL_PASSWORD` in `.envs/epa.postgres`, respectively
57
57
58
-
* Define an environment variable `MVS_HOST_API` in `.envs/epa.postgres` and set the url of the simulation server
58
+
* Define an environment variable `MVS_HOST_API` in `.envs/epa.postgres` and set the url of the simulation server
59
59
you wish to use for your models (for example `MVS_API_HOST="<url to your favorite simulation server>"`), you can deploy your own [simulation server](https://github.com/open-plan-tool/simulation-server) locally if you need
60
60
61
61
* Assign the domain of your website (without `http://` or `https://`) to `TRUSTED_HOST` , see https://docs.djangoproject.com/en/4.2/ref/settings/#csrf-trusted-origins for more information
62
62
63
63
Next you can either provide the following commands inside a terminal (with ubuntu you might have to prepend `sudo`)
64
64
*`docker-compose --file=docker-compose-postgres.yml up -d --build` (you can replace `postgres` by `mysql` if you want to use mysql)
65
-
*`docker-compose --file=docker-compose-postgres.yml exec -u root app_pg sh initial_setup.sh` (this will also load a default testUser account with sample scenario).
65
+
*`docker-compose --file=docker-compose-postgres.yml exec -u root app_pg sh initial_setup.sh` (this will also load a default testUser account with sample scenario).
66
66
67
67
Or you can run a python script with the following command
68
68
*`python deploy.py -db postgres`
@@ -72,7 +72,7 @@ Finally
72
72
* You can then login with `testUser` and `ASas12,.` or create your own account
73
73
74
74
### Proxy settings (optional)
75
-
If you use a proxy you will need to set `USE_PROXY=True` and edit `PROXY_ADDRESS=http://proxy_address:port` with your proxy settings in `.envs/epa.postgres`.
75
+
If you use a proxy you will need to set `USE_PROXY=True` and edit `PROXY_ADDRESS=http://proxy_address:port` with your proxy settings in `.envs/epa.postgres`.
76
76
77
77
>**_NOTE:_** If you wish to use mysql instead of postgres, simply replace `postgres` by `mysql` and `app_pg` by `app` in the above commands or filenames
78
78
<hr>
@@ -89,7 +89,7 @@ If you use a proxy you will need to set `USE_PROXY=True` and edit `PROXY_ADDRESS
89
89
90
90
## Tear down (uninstall) docker containers
91
91
To remove the application (including relevant images, volumes etc.), one can use the following commands in terminal:
92
-
92
+
93
93
`docker-compose down --file=docker-compose-postgres.yml -v`
94
94
95
95
you can add `--rmi local` if you wish to also remove the images (this will take you a long time to rebuild the docker containers from scratch if you want to redeploy the app later then)
0 commit comments