Skip to content

Commit

Permalink
Update installation documentation (naturalsolutions#56)
Browse files Browse the repository at this point in the history
  • Loading branch information
geobrun authored Jan 2, 2024
1 parent 40a3988 commit 416f854
Showing 1 changed file with 26 additions and 12 deletions.
38 changes: 26 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,41 +32,55 @@ 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

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:

Expand Down

0 comments on commit 416f854

Please sign in to comment.