You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: self-hosted/docker-compose.mdx
+7-46Lines changed: 7 additions & 46 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,12 +5,18 @@ description: Deploy DeployStack using Docker Compose for a quick and reliable se
5
5
6
6
# Docker Compose Setup
7
7
8
-
Deploy DeployStack using Docker Compose for a production-ready, self-hosted installation. This method is recommended for most users as it provides a reliable, scalable setup with minimal configuration.
8
+
Deploy DeployStack using Docker Compose for a quick and reliable self-hosted installation. This method is recommended for most users as it provides a reliable setup with minimal configuration.
9
9
10
10
<Info>
11
11
Docker containers are for production hosting or self-hosting. For development contributions, check the [Local Setup](/local-setup) guide.
12
12
</Info>
13
13
14
+
<Info>
15
+
**Deployment Type**: This guide covers **development and single-team deployments**. The satellite runs without process isolation, suitable for local development or when serving only your own team.
16
+
17
+
For **production deployments with multiple teams** or external users, see [Production Satellite Setup](/self-hosted/production-satellite) which includes nsjail process isolation for security and team separation.
18
+
</Info>
19
+
14
20
## Overview
15
21
16
22
This guide provides step-by-step instructions to install and configure DeployStack using Docker Compose. The setup includes frontend, backend, and **required satellite service** with persistent data storage and proper networking.
@@ -27,37 +33,6 @@ This guide provides step-by-step instructions to install and configure DeploySta
27
33
-**Docker & Docker Compose**: Make sure both are installed and up-to-date.
28
34
-**Storage**: At least 2GB of available disk space for images and persistent data.
29
35
30
-
### Linux Host Requirements
31
-
32
-
<Warning>
33
-
**For Linux deployments only**: To enable nsjail process isolation in the satellite service, your Linux host must have unprivileged user namespaces enabled.
34
-
</Warning>
35
-
36
-
Check if already enabled:
37
-
38
-
```bash
39
-
cat /proc/sys/kernel/unprivileged_userns_clone
40
-
# Should return: 1
41
-
```
42
-
43
-
If not enabled (returns 0 or file doesn't exist), enable it:
44
-
45
-
```bash
46
-
echo'kernel.unprivileged_userns_clone=1'| sudo tee /etc/sysctl.d/00-userns.conf
47
-
sudo sysctl -p /etc/sysctl.d/00-userns.conf
48
-
```
49
-
50
-
Verify the setting:
51
-
52
-
```bash
53
-
cat /proc/sys/kernel/unprivileged_userns_clone
54
-
# Should now return: 1
55
-
```
56
-
57
-
<Info>
58
-
**Note**: This setting is only required for production Linux deployments. Development on macOS/Windows doesn't need this configuration.
59
-
</Info>
60
-
61
36
## Beggining the setup for Docker Compose
62
37
63
38
Follow these steps for a setup with docker compsoe
@@ -188,20 +163,6 @@ The satellite service is **already included** in the docker-compose.yml file. Yo
188
163
189
164
**Note**: After initial registration, the satellite saves its API key to persistent storage and doesn't need the registration token for subsequent starts.
190
165
191
-
<Info>
192
-
**Alternative for systems without host-level sysctl configuration**: If you cannot modify the host system's kernel parameters, you can add the `--sysctl` flag to the satellite service in your `docker-compose.yml`:
193
-
194
-
```yaml
195
-
services:
196
-
satellite:
197
-
# ... other configuration ...
198
-
sysctls:
199
-
- kernel.unprivileged_userns_clone=1
200
-
```
201
-
202
-
Note that this requires Docker to run with additional privileges and is less secure than configuring the host system directly.
0 commit comments