|
3 | 3 | ```bash |
4 | 4 | $ CONFIG_VAR=xxx make start |
5 | 5 | ``` |
6 | | - |
| 6 | + |
7 | 7 | ## 1. Api Engine |
8 | 8 |
|
9 | 9 | all related configuration variable is written in ==.makerc/api-engine==. |
10 | 10 |
|
11 | 11 | ???+ info "API_ENGINE_WEBROOT" |
12 | 12 |
|
13 | 13 | **default**: `/engine` |
14 | | - |
| 14 | + |
15 | 15 | **description**: {>>Web ROOT for api engine, which defined the url where user can visit to api engine.<<} |
16 | | - |
| 16 | + |
17 | 17 | **usage**: |
18 | 18 | ```bash |
19 | 19 | $ API_ENGINE_WEBROOT=/engine make start |
20 | 20 | ``` |
21 | | - |
22 | | - |
| 21 | + |
| 22 | + |
23 | 23 | ???+ info "API_ENGINE_SERVICE_PORT" |
24 | 24 |
|
25 | 25 | **default**: `8085` |
26 | | - |
| 26 | + |
27 | 27 | **description**: {>>External port of api engine, only work for docker-compose deploy.<<} |
28 | | - |
| 28 | + |
29 | 29 | **usage**: |
30 | 30 | ```bash |
31 | 31 | $ API_ENGINE_SERVICE_PORT=8085 make start |
32 | 32 | ``` |
33 | | - |
| 33 | + |
34 | 34 | ???+ info "API_ENGINE_ADMIN_TOKEN" |
35 | 35 |
|
36 | 36 | **default**: `administrator` |
37 | | - |
| 37 | + |
38 | 38 | **description**: {>>Default operator token of api engine, which have the maximum rights.<<} |
39 | | - |
| 39 | + |
40 | 40 | **usage**: |
41 | 41 | ```bash |
42 | 42 | $ API_ENGINE_ADMIN_TOKEN=administrator make start |
43 | 43 | ``` |
44 | | - |
| 44 | + |
45 | 45 | ???+ info "API_ENGINE_ADMIN_USERNAME" |
46 | 46 |
|
47 | 47 | **default**: `admin` |
48 | | - |
| 48 | + |
49 | 49 | **description**: {>>Default operator username of api engine, who have the maximum rights.<<} |
50 | | - |
| 50 | + |
51 | 51 | **usage**: |
52 | 52 | ```bash |
53 | 53 | $ API_ENGINE_ADMIN_USERNAME=admin make start |
54 | 54 | ``` |
55 | | - |
| 55 | + |
56 | 56 | ???+ info "API_ENGINE_ADMIN_PASSWORD" |
57 | 57 |
|
58 | 58 | **default**: `pass` |
59 | | - |
| 59 | + |
60 | 60 | **description**: {>>Default operator pass of api engine, who have the maximum rights.<<} |
61 | | - |
| 61 | + |
62 | 62 | **usage**: |
63 | 63 | ```bash |
64 | 64 | $ API_ENGINE_ADMIN_PASSWORD=pass make start |
65 | 65 | ``` |
66 | | - |
| 66 | + |
67 | 67 | ???+ info "API_ENGINE_ADMIN_EMAIL" |
68 | 68 |
|
69 | 69 | **default**: `admin@cello.com` |
70 | | - |
| 70 | + |
71 | 71 | **description**: {>>Default admin email of api engine, who have the maximum rights.<<} |
72 | | - |
| 72 | + |
73 | 73 | **usage**: |
74 | 74 | ```bash |
75 | 75 | $ API_ENGINE_ADMIN_EMAIL=admin@cello.com make start |
76 | 76 | ``` |
77 | | - |
| 77 | + |
78 | 78 | ???+ info "API_DOCKER_HOST" |
79 | 79 |
|
80 | 80 | **default**: `unix://var/run/docker.sock` |
81 | | - |
82 | | - **description**: {>>Docker host for launch agent container, can be unix socket or ip:port, |
| 81 | + |
| 82 | + **description**: {>>Docker host for launch agent container, can be unix socket or ip:port, |
83 | 83 | if use remote docker host, remember download all agent images.<<} |
84 | | - |
| 84 | + |
85 | 85 | **usage**: |
86 | 86 | ```bash |
87 | 87 | $ API_DOCKER_HOST=unix://var/run/docker.sock make start |
88 | 88 | ``` |
89 | | - |
| 89 | + |
90 | 90 | ???+ info "API_VERSION" |
91 | 91 |
|
92 | 92 | **default**: `master` |
93 | | - |
| 93 | + |
94 | 94 | **description**: {>>API version shown in swagger.<<} |
95 | | - |
| 95 | + |
96 | 96 | **usage**: |
97 | 97 | ```bash |
98 | 98 | $ API_VERSION=master make start |
99 | 99 | ``` |
100 | 100 |
|
101 | 101 | ## 2. Dashboard |
102 | | - |
| 102 | + |
103 | 103 | ???+ info "DASHBOARD_SERVICE_PORT" |
104 | 104 |
|
105 | 105 | **default**: `8085` |
106 | | - |
| 106 | + |
107 | 107 | **description**: {>>External port for dashboard, only work for docker-compose.<<} |
108 | | - |
| 108 | + |
109 | 109 | **usage**: |
110 | 110 | ```bash |
111 | 111 | $ DASHBOARD_SERVICE_PORT=8085 make start |
112 | 112 | ``` |
113 | 113 |
|
114 | 114 | Below configurations only work for `make start-dashboard-dev`, and must install all need node modules under the src/dashboard folder. |
115 | | - |
| 115 | + |
116 | 116 | ???+ info "MOCK" |
117 | 117 |
|
118 | 118 | **default**: `True` |
119 | | - |
| 119 | + |
120 | 120 | **description**: {>>Whether start the dashboard with mock mode, all the data is mock.<<} |
121 | | - |
| 121 | + |
122 | 122 | **usage**: |
123 | 123 | ```bash |
124 | 124 | $ Mock=True make start-dashboard-dev |
125 | 125 | ``` |
126 | | - |
| 126 | + |
127 | 127 | ???+ info "PROXY" |
128 | 128 |
|
129 | 129 | **default**: `empty` |
130 | | - |
| 130 | + |
131 | 131 | **description**: {>>When MOCK=False, this variable will have effect, |
132 | 132 | set the api engine server url, where the api request will redirect to.<<} |
133 | | - |
| 133 | + |
134 | 134 | **usage**: |
135 | 135 | ```bash |
136 | 136 | $ PROXY=http://api-engine-server:8085/engine make start-dashboard-dev |
|
0 commit comments