Updated UI with accounts and fixed routing
This commit is contained in:
30
README.md
30
README.md
@@ -4,7 +4,10 @@
|
||||
</div>
|
||||
|
||||
## Makefile
|
||||
`make help` to list all commands
|
||||
* `make` or `make help` to list all commands
|
||||
* `make docker-up` to start all containers
|
||||
* `make docker-clean` to stop and delete all containers, volumes, and networks related
|
||||
to the application
|
||||
|
||||
## Setup
|
||||
|
||||
@@ -17,6 +20,31 @@
|
||||
* Running just `make cert` will generate `localhost` certificates
|
||||
4. Run the application with `make up`
|
||||
|
||||
### Production Environment
|
||||
The most likely to change environment variables are the following:
|
||||
* `UI_PORT`
|
||||
* `API_PORT`
|
||||
* `POSTGRES_PORT`
|
||||
* `POSTGRES_PASSWORD` - Please change in production environments
|
||||
* `MINIO_HOST` - Match to the `NGINX_HOST` value (see below)
|
||||
* `MINIO_ROOT_PASSWORD` - Please change in production environments
|
||||
* `NGINX_HOST` - The IP address of the system
|
||||
* `NGINX_INTERNAL_HOST` - Typically `host.docker.internal` or `172.17.0.1`
|
||||
to allow communication within the docker network
|
||||
* `ENVIRONMENT` - Change to `production`
|
||||
* `ADMIN_EMAIL` - Please change in production environments
|
||||
* `ADMIN_PASSWORD` - Please change in production environments
|
||||
* `VITE_API_URL` - Change to the FQDN of the URL that is reachable through the internet.
|
||||
For example: `https://aviaation.bensherriff.com`
|
||||
* `__VITE_ADDITIONAL_SERVER_ALLOWED_HOSTS` - Change to the domain of the `VITE_API_URL`.
|
||||
For example: `aviation.bensherriff.com`
|
||||
|
||||
If the App is not directly exposed to the internet (i.e., behind another reverse proxy or similar),
|
||||
then `NGINX_SSL_ENABLED` most likely should be `false`. The `NGINX_SSL_ENABLED` should only be
|
||||
enabled when you need to setup SSL directly. However, the SSL configuration is incomplete, and may
|
||||
require additional configuration that is not included in this README.
|
||||
* Additionally, run `make cert` to generate certificates.
|
||||
|
||||
## Data Sources
|
||||
|
||||
### Airport Data
|
||||
|
||||
Reference in New Issue
Block a user