diff --git a/README.md b/README.md index 7f108fa..851a326 100644 --- a/README.md +++ b/README.md @@ -32,16 +32,20 @@ try it out! User : admin ; password : password --- ## Installation -### Cloning -Clone this project using git +### Prerequisite -Go inside the directory generated +Docker and docker-compose must be installed on the server/machine (cf. [official website](https://docs.docker.com/engine/install/debian/)). -Since this app has not been released yet, no commits are available on main -branch. Switch to `dev` branch: +### Application downloading + +Replace the `X.Y.Z` mention by the name of the release you want to install. ``` -git checkout dev +cd +wget https://github.com/naturalsolutions/geocam/archive/refs/tags/X.Y.Z.zip +unzip X.Y.Z.zip +rm X.Y.Z.zip +mv geocam-X.Y.Z geocam/ ``` ### Settings @@ -49,24 +53,34 @@ git checkout dev Copy the `.env.sample` inside the docker directory to `.env`: ``` +cd geocam cp docker/.env.sample docker/.env +nano docker/.env ``` -Edit freely this `.env` file to change credentials for instance. +Edit freely this `.env` file to change credentials for instance. Here are the main parameters you usually want to modify: +- `ENV` : uncomment it to activate the production mode (only if your app has been configured with a domain name) +- `DOMAIN` : localhost, an IP address or a domain name (according to your context) +- `PROTOCOL` : modify it to "https" if you want to activate HTTPS +- `HTTP_HTTPS_PORT` : usually 80 for HTTP protocol and 443 for HTTPS +- `DB_USER` : the name you want for the DB user +- `DB_PASSWORD` : the password you want for the DB user +- `DB_NAME` : the name you want for the DB +- `MINIO_ROOT_USER` : the name you want for the Minio user +- `MINIO_ROOT_PASSWORD` : the password you want for the Minio user -### Launching +In the current version (`0.1.1`), you can't modify the `APP_USER` and the `APP_PASSWORD` directly in this file. You will be able to modify the admin password trough Keycloak later on. -Docker and docker-compose must be installed on the server/machine. Then: +### Launching ``` ./scripts/docker.sh up -d ``` -App will run on `http://localhost:8889/` but the port of each service -will be avaible to debug. +With the default settings, the app will run on `http://localhost:8889/` but the port of each service will be avaible to debug. This URL must be adapted to your context (depending on chosen protocol, domain and port). -## Sample data +## Sample data (for testing only) Sample data can be generated by using the following command: