0331 configurations (#177)

* Updated configurations

* Update README.md
This commit is contained in:
writinwaters 2024-03-31 17:51:14 +08:00 committed by GitHub
parent dad0d2eb9d
commit 9ff38891ad
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -55,7 +55,8 @@
- CPU >= 2 cores
- RAM >= 8 GB
- Docker: If you have not installed Docker on your local machine (Windows, Mac, or Linux), see [Install Docker Engine](https://docs.docker.com/engine/install/).
- Docker
> If you have not installed Docker on your local machine (Windows, Mac, or Linux), see [Install Docker Engine](https://docs.docker.com/engine/install/).
### Start up the server
@ -117,20 +118,30 @@ INFO:werkzeug:Press CTRL+C to quit
```
5. In your web browser, enter the IP address of your server as prompted.
*The show is on!*
## 🔧 Configurations
> The default serving port is 80, if you want to change that, refer to the [docker-compose.yml](./docker-compose.yaml) and change the left part of `80:80`, say `66:80`.
When it comes to system configurations, you will need to manage the following files:
If you need to change the default setting of the system when you deploy it. There several ways to configure it.
Please refer to this [README](./docker/README.md) to manually update the configuration.
Updates to system configurations require a system reboot to take effect *docker-compose up -d* again.
- [.env](./docker/.env): Keeps the fundamental setups for the system, such as `SVR_HTTP_PORT`, `MYSQL_PASSWORD`, and `MINIO_PASSWORD`.
- [service_conf.yaml](./docker/service_conf.yaml): Configures the back-end services.
- [docker-compose.yml](./docker-compose.yaml): The system relies on [docker-compose.yml](./docker-compose.yaml) to start up.
> If you want to change the basic setups, like port, password .etc., please refer to [.env](./docker/.env) before starting up the system.
> If you change anything in [.env](./docker/.env), please check [service_conf.yaml](./docker/service_conf.yaml) which is a configuration of the back-end service and should be consistent with [.env](./docker/.env).
You must ensure that changes in [.env](./docker/.env) are in line with what are in the [service_conf.yaml](./docker/service_conf.yaml) file.
> The [./docker/README](./docker/README.md) file provides a detailed description of the environment settings and service configurations, and it is IMPORTANT to ensure that all environment settings listed in the [./docker/README](./docker/README.md) file should be aligned with the corresponding settings in the [service_conf.yaml](./docker/service_conf.yaml) file.
To change the default serving port (80), go to [docker-compose.yml](./docker-compose.yaml) and change `80:80` to `<YOUR_SERVING_PORT>:80`.
> Updates to all system configurations require a system reboot to take effect:
>
> ```bash
> $ docker-compose up -d
> ```
## 🛠️ Build from source