@@ -3,8 +3,6 @@ title: Installation
33icon : IconDownload
44---
55
6-
7-
86import {Step , Steps } from ' fumadocs-ui/components/steps' ;
97
108This guide will walk you through the deployment of CodeZero using Docker. Currently, CodeZero is in active development,
@@ -20,148 +18,150 @@ Before beginning, ensure you have the following installed on your system:
2018
2119<Steps >
2220
23- <Step >
21+ <Step >
22+
23+ ## Clone the latest release
24+
25+ To ensure stability, we recommend using the latest release. Run the following command to clone the
26+ repository:
2427
25- ## Clone the latest release
28+ Get the newest release version from the [ CodeZero GitHub releases page ] ( https://github.com/code0-tech/codezero/releases )
2629
27- To ensure stability, we recommend using the latest release. Run the following command to clone the
28- repository:
30+ ``` bash
31+ git clone --branch < version> https://github.com/code0-tech/codezero.git
32+ ```
2933
30- Get the newest release version from the [ CodeZero GitHub releases page ] ( https://github.com/code0-tech/codezero/releases )
34+ Navigate to the deployment directory:
3135
32- ``` bash
33- git clone --branch < version > https://github.com/code0-tech/codezero.git
34- ```
36+ ``` bash
37+ cd codezero/docker-compose/
38+ ```
3539
36- Navigate to the deployment directory:
40+ </Step >
41+ <Step >
3742
38- ``` bash
39- cd codezero/docker-compose/
40- ```
43+ ## Configure environment variables
4144
42- </Step >
43- <Step >
44- ## Configure environment variables
45+ CodeZero uses an ` .env ` file to manage initial credentials and system settings. Create or edit the file:
4546
46- CodeZero uses an ` .env ` file to manage initial credentials and system settings. Create or edit the file:
47+ ``` bash
48+ nano .env
49+ ```
4750
48- ``` bash
49- nano .env
50- ```
51+ ### The .env template
5152
52- ### The .env template
53+ Ensure your ` .env ` file contains the following variables. Pay close attention to the Root Credentials and the
54+ Image
55+ Edition.
5356
54- Ensure your ` .env ` file contains the following variables. Pay close attention to the Root Credentials and the
55- Image
56- Edition.
57+ ``` bash
58+ # IDE config
59+ HOSTNAME=localhost
60+ HTTP_PORT=80
61+ HTTPS_PORT=443
62+ SSL_ENABLED=false
63+ SSL_CERT_FILE= # must be located in ./certs, defaults to "<hostname>.pem"
64+ SSL_KEY_FILE= # must be located in ./certs, defaults to "<hostname>.key"
5765
58- ``` bash
59- # IDE config
60- HOSTNAME=localhost
61- HTTP_PORT=80
62- HTTPS_PORT=443
63- SSL_ENABLED=false
64- SSL_CERT_FILE= # must be located in ./certs, defaults to "<hostname>.pem"
65- SSL_KEY_FILE= # must be located in ./certs, defaults to "<hostname>.key"
66+ INITIAL_ROOT_PASSWORD=root
67+ INITIAL_ROOT_MAIL=root@code0.tech
6668
67- INITIAL_ROOT_PASSWORD=root
68- INITIAL_ROOT_MAIL=root@code0.tech
69+ # Runtime config
70+ AQUILA_SAGITTARIUS_URL=http://nginx:80
71+ AQUILA_SAGITTARIUS_TOKEN=
72+ DRACO_REST_PORT=8084
6973
70- # Runtime config
71- AQUILA_SAGITTARIUS_URL=http://nginx:80
72- AQUILA_SAGITTARIUS_TOKEN=
73- DRACO_REST_PORT=8084
74+ # Active services
75+ COMPOSE_PROFILES=ide,runtime
7476
75- # Active services
76- COMPOSE_PROFILES=ide,runtime
77+ # Image config
78+ IMAGE_REGISTRY=registry.gitlab.com/code0-tech/packages
79+ IMAGE_TAG= # version
80+ IMAGE_EDITION= # ce or ee
7781
78- # Image config
79- IMAGE_REGISTRY=registry.gitlab.com/code0-tech/packages
80- IMAGE_TAG= # version
81- IMAGE_EDITION= # ce or ee
82+ # Internal config options
83+ SAGITTARIUS_RAILS_HOST=sagittarius-rails-web
84+ SAGITTARIUS_RAILS_PORT=3000
85+ SAGITTARIUS_GRPC_HOST=sagittarius-grpc
86+ SAGITTARIUS_GRPC_PORT=50051
87+ SAGITTARIUS_LOG_LEVEL=info
88+ SCULPTOR_HOST=sculptor
89+ SCULPTOR_PORT=3000
90+ POSTGRES_HOST=postgres
91+ POSTGRES_PORT=5432
92+ POSTGRES_DB=sagittarius_production
93+ POSTGRES_USER=sagittarius
94+ POSTGRES_PASSWORD=sagittarius
95+ ```
8296
83- # Internal config options
84- SAGITTARIUS_RAILS_HOST=sagittarius-rails-web
85- SAGITTARIUS_RAILS_PORT=3000
86- SAGITTARIUS_GRPC_HOST=sagittarius-grpc
87- SAGITTARIUS_GRPC_PORT=50051
88- SAGITTARIUS_LOG_LEVEL=info
89- SCULPTOR_HOST=sculptor
90- SCULPTOR_PORT=3000
91- POSTGRES_HOST=postgres
92- POSTGRES_PORT=5432
93- POSTGRES_DB=sagittarius_production
94- POSTGRES_USER=sagittarius
95- POSTGRES_PASSWORD=sagittarius
96- ```
97+ ### Key parameters
9798
98- ### Key parameters:
99+ - ` INITIAL_ROOT_MAIL ` : The email address for the primary administrator.
100+ - ` INITIAL_ROOT_PASSWORD ` : The secure password for your first login.
101+ - ` IMAGE_EDITION ` : Set this to ce for the Community Edition or ee for the Enterprise Edition. This
102+ determines which Docker images will be pulled.
99103
100- - ` INITIAL_ROOT_MAIL ` : The email address for the primary administrator.
101- - ` INITIAL_ROOT_PASSWORD ` : The secure password for your first login.
102- - ` IMAGE_EDITION ` : Set this to ce for the Community Edition or ee for the Enterprise Edition. This
103- determines which Docker images will be pulled.
104+ </Step >
105+ <Step >
104106
105- </Step >
106- <Step >
107+ ## Initial deployment
107108
108- ## Initial deployment
109+ Start the CodeZero containers in detached mode:
109110
110- Start the CodeZero containers in detached mode:
111+ ``` bash
112+ docker compose up -d
113+ ```
111114
112- ``` bash
113- docker compose up -d
114- ```
115+ Once the containers are running, you can access the CodeZero Dashboard via your browser (typically
116+ at <http://localhost/>).
115117
116- Once the containers are running, you can access the CodeZero Dashboard via your browser (typically
117- at http://localhost/ ).
118+ </Step>
119+ <Step>
118120
119- </Step >
120- <Step >
121+ ## Connecting the runtime
121122
122- ## Connecting the runtime
123+ A " Runtime" is the engine that executes your flows. To activate it, you must generate a unique token within the
124+ dashboard and link it to your configuration.
123125
124- A "Runtime" is the engine that executes your flows. To activate it, you must generate a unique token within the
125- dashboard and link it to your configuration.
126+ ### Login
126127
127- ### Login
128+ Log in to the dashboard using the `INITIAL_ROOT_MAIL` and `INITIAL_ROOT_PASSWORD` you defined in your `.env`
129+ file.
128130
129- Log in to the dashboard using the ` INITIAL_ROOT_MAIL ` and ` INITIAL_ROOT_PASSWORD ` you defined in your ` .env `
130- file.
131+ 
131132
132- ![ CodeZero Thumbnail ] ( ../../public/CodeZero_Login.png )
133+ ### Create organization or navigate to personal workspace
133134
134- ### Create organization or navigate to personal workspace
135+ 
135136
136- ![ CodeZero Thumbnail ] ( ../../public/CodeZero_Install_Overview.png )
137+ ### Navigate to runtimes
137138
138- ### Navigate to runtimes
139+ 
139140
140- ![ CodeZero Thumbnail ] ( ../../public/CodeZero_Install_Click-on-Runtime.png )
141+ ### Create new runtime
141142
142- ### Create new runtime
143+ 
143144
144- ![ CodeZero Thumbnail ] ( ../../public/CodeZero_Install_Create-Runtime.png )
145+ ### Copy the generated token
145146
146- ### Copy the generated token
147+ 
147148
148- ![ CodeZero Thumbnail ] ( ../../public/CodeZero_Install_Copy-Token.png )
149+ ### Update your `.env` file
149150
150- ### Update your ` .env ` file
151+ Update your .env file with the copied token at `AQUILA_SAGITTARIUS_TOKEN` and save the file.
151152
152- Update your .env file with the copied token at ` AQUILA_SAGITTARIUS_TOKEN ` and save the file.
153+ </Step>
154+ <Step>
153155
154- </Step >
155- <Step >
156+ ## Finalize the setup
156157
157- ## Finalize the setup
158+ For the changes to take effect and for the runtime to authenticate correctly, restart the containers:
158159
159- For the changes to take effect and for the runtime to authenticate correctly, restart the containers:
160+ ```bash
161+ docker compose restart
162+ ```
160163
161- ``` bash
162- docker compose restart
163- ```
164- </Step >
164+ </Step>
165165
166166</Steps>
167167
0 commit comments