writinwaters commited on
Commit
7943d52
·
1 Parent(s): 7c4aa10

0331 configurations (#177)

Browse files

* Updated configurations

* Update README.md

Files changed (1) hide show
  1. README.md +31 -20
README.md CHANGED
@@ -55,7 +55,8 @@
55
 
56
  - CPU >= 2 cores
57
  - RAM >= 8 GB
58
- - 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/).
 
59
 
60
  ### Start up the server
61
 
@@ -102,35 +103,45 @@
102
  ```
103
  *The following output confirms a successful launch of the system:*
104
 
105
- ```bash
106
- ____ ______ __
107
- / __ \ ____ _ ____ _ / ____// /____ _ __
108
- / /_/ // __ `// __ `// /_ / // __ \| | /| / /
109
- / _, _// /_/ // /_/ // __/ / // /_/ /| |/ |/ /
110
- /_/ |_| \__,_/ \__, //_/ /_/ \____/ |__/|__/
111
- /____/
112
-
113
- * Running on all addresses (0.0.0.0)
114
- * Running on http://127.0.0.1:9380
115
- * Running on http://172.22.0.5:9380
116
- INFO:werkzeug:Press CTRL+C to quit
117
- ```
118
 
119
  5. In your web browser, enter the IP address of your server as prompted.
 
120
  *The show is on!*
121
 
122
 
123
  ## 🔧 Configurations
124
 
125
- > 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`.
 
 
 
 
 
 
 
126
 
127
- If you need to change the default setting of the system when you deploy it. There several ways to configure it.
128
- Please refer to this [README](./docker/README.md) to manually update the configuration.
129
- Updates to system configurations require a system reboot to take effect *docker-compose up -d* again.
130
 
131
- > If you want to change the basic setups, like port, password .etc., please refer to [.env](./docker/.env) before starting up the system.
132
 
133
- > 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).
 
 
 
 
134
 
135
  ## 🛠️ Build from source
136
 
 
55
 
56
  - CPU >= 2 cores
57
  - RAM >= 8 GB
58
+ - Docker
59
+ > If you have not installed Docker on your local machine (Windows, Mac, or Linux), see [Install Docker Engine](https://docs.docker.com/engine/install/).
60
 
61
  ### Start up the server
62
 
 
103
  ```
104
  *The following output confirms a successful launch of the system:*
105
 
106
+ ```bash
107
+ ____ ______ __
108
+ / __ \ ____ _ ____ _ / ____// /____ _ __
109
+ / /_/ // __ `// __ `// /_ / // __ \| | /| / /
110
+ / _, _// /_/ // /_/ // __/ / // /_/ /| |/ |/ /
111
+ /_/ |_| \__,_/ \__, //_/ /_/ \____/ |__/|__/
112
+ /____/
113
+
114
+ * Running on all addresses (0.0.0.0)
115
+ * Running on http://127.0.0.1:9380
116
+ * Running on http://172.22.0.5:9380
117
+ INFO:werkzeug:Press CTRL+C to quit
118
+ ```
119
 
120
  5. In your web browser, enter the IP address of your server as prompted.
121
+
122
  *The show is on!*
123
 
124
 
125
  ## 🔧 Configurations
126
 
127
+ When it comes to system configurations, you will need to manage the following files:
128
+
129
+ - [.env](./docker/.env): Keeps the fundamental setups for the system, such as `SVR_HTTP_PORT`, `MYSQL_PASSWORD`, and `MINIO_PASSWORD`.
130
+ - [service_conf.yaml](./docker/service_conf.yaml): Configures the back-end services.
131
+ - [docker-compose.yml](./docker-compose.yaml): The system relies on [docker-compose.yml](./docker-compose.yaml) to start up.
132
+
133
+
134
+ 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.
135
 
136
+ > 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.
 
 
137
 
138
+ To change the default serving port (80), go to [docker-compose.yml](./docker-compose.yaml) and change `80:80` to `<YOUR_SERVING_PORT>:80`.
139
 
140
+ > Updates to all system configurations require a system reboot to take effect:
141
+ >
142
+ > ```bash
143
+ > $ docker-compose up -d
144
+ > ```
145
 
146
  ## 🛠️ Build from source
147