Skip to content

Commit 447c75c

Browse files
committed
feat: add installation guide for CodeZero deployment using Docker
1 parent bf4bbd0 commit 447c75c

1 file changed

Lines changed: 166 additions & 0 deletions

File tree

content/general/install.mdx

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
---
2+
title: Installation
3+
icon: IconDownload
4+
---
5+
6+
7+
8+
import {Step, Steps} from 'fumadocs-ui/components/steps';
9+
10+
This guide will walk you through the deployment of CodeZero using Docker. Currently, CodeZero is in active development,
11+
and we are focused on building our community of early adopters. Follow these steps to set up your environment and
12+
connect your first runtime.
13+
14+
## Prerequisites
15+
16+
Before beginning, ensure you have the following installed on your system:
17+
18+
- Git
19+
- Docker and Docker Compose
20+
21+
<Steps>
22+
23+
<Step>
24+
25+
## Clone the latest release
26+
27+
To ensure stability, we recommend using the latest canary release. Run the following command to clone the
28+
repository:
29+
30+
```bash
31+
git clone --branch <version> https://github.com/code0-tech/codezero.git
32+
```
33+
34+
Navigate to the deployment directory:
35+
36+
```bash
37+
cd codezero/docker-compose/
38+
```
39+
40+
</Step>
41+
<Step>
42+
## Configure environment variables
43+
44+
CodeZero uses an `.env` file to manage initial credentials and system settings. Create or edit the file:
45+
46+
```bash
47+
nano .env
48+
```
49+
50+
### The .env template
51+
52+
Ensure your `.env` file contains the following variables. Pay close attention to the Root Credentials and the
53+
Image
54+
Edition.
55+
56+
```bash
57+
# IDE config
58+
HOSTNAME=localhost
59+
HTTP_PORT=80
60+
HTTPS_PORT=443
61+
SSL_ENABLED=false
62+
SSL_CERT_FILE= # must be located in ./certs, defaults to "<hostname>.pem"
63+
SSL_KEY_FILE= # must be located in ./certs, defaults to "<hostname>.key"
64+
65+
INITIAL_ROOT_PASSWORD=root
66+
INITIAL_ROOT_MAIL=root@code0.tech
67+
68+
# Runtime config
69+
AQUILA_SAGITTARIUS_URL=http://nginx:80
70+
AQUILA_SAGITTARIUS_TOKEN=
71+
DRACO_REST_PORT=8084
72+
73+
# Active services
74+
COMPOSE_PROFILES=ide,runtime
75+
76+
# Image config
77+
IMAGE_REGISTRY=registry.gitlab.com/code0-tech/packages
78+
IMAGE_TAG= # version
79+
IMAGE_EDITION= # ce or ee
80+
81+
# Internal config options
82+
SAGITTARIUS_RAILS_HOST=sagittarius-rails-web
83+
SAGITTARIUS_RAILS_PORT=3000
84+
SAGITTARIUS_GRPC_HOST=sagittarius-grpc
85+
SAGITTARIUS_GRPC_PORT=50051
86+
SAGITTARIUS_LOG_LEVEL=info
87+
SCULPTOR_HOST=sculptor
88+
SCULPTOR_PORT=3000
89+
POSTGRES_HOST=postgres
90+
POSTGRES_PORT=5432
91+
POSTGRES_DB=sagittarius_production
92+
POSTGRES_USER=sagittarius
93+
POSTGRES_PASSWORD=sagittarius
94+
```
95+
96+
### Key parameters:
97+
98+
- `INITIAL_ROOT_MAIL`: The email address for the primary administrator.
99+
- `INITIAL_ROOT_PASSWORD`: The secure password for your first login.
100+
- `IMAGE_EDITION`: Set this to ce for the Community Edition or ee for the Enterprise Edition. This
101+
determines which Docker images will be pulled.
102+
103+
</Step>
104+
<Step>
105+
106+
## Initial deployment
107+
108+
Start the CodeZero containers in detached mode:
109+
110+
```bash
111+
docker compose up -d
112+
```
113+
114+
Once the containers are running, you can access the CodeZero Dashboard via your browser (typically
115+
at http://localhost:3000).
116+
117+
</Step>
118+
<Step>
119+
120+
## Connecting the runtime
121+
122+
A "Runtime" is the engine that executes your flows. To activate it, you must generate a unique token within the
123+
dashboard and link it to your configuration.
124+
125+
### Login
126+
127+
Log in to the dashboard using the `INITIAL_ROOT_MAIL` and `INITIAL_ROOT_PASSWORD` you defined in your `.env`
128+
file.
129+
130+
![CodeZero Thumbnail](../../public/CodeZero_Login.png)
131+
132+
### Create organization or navigate to personal workspace
133+
134+
![CodeZero Thumbnail](../../public/CodeZero_Install_Overview.png)
135+
136+
### Navigate to runtimes
137+
138+
![CodeZero Thumbnail](../../public/CodeZero_Install_Click-on-Runtime.png)
139+
140+
### Create new runtime
141+
142+
![CodeZero Thumbnail](../../public/CodeZero_Install_Create-Runtime.png)
143+
144+
### Copy the generated token
145+
146+
![CodeZero Thumbnail](../../public/CodeZero_Install_Copy-Token.png)
147+
148+
### Update your `.env` file
149+
150+
Update your .env file with the copied token at `AQUILA_SAGITTARIUS_TOKEN` and save the file.
151+
152+
</Step>
153+
<Step>
154+
155+
## Finalize the setup
156+
157+
For the changes to take effect and for the runtime to authenticate correctly, restart the containers:
158+
159+
```bash
160+
docker compose restart
161+
```
162+
</Step>
163+
164+
</Steps>
165+
166+
Your CodeZero instance is now fully configured and ready to manage your enterprise flows and organizational structures.

0 commit comments

Comments
 (0)