Skip to content

Commit c8fad50

Browse files
author
Lasim
committed
feat: Revise documentation for Docker Compose and production satellite setup, enhancing clarity on deployment types and requirements
1 parent a67429c commit c8fad50

File tree

3 files changed

+765
-113
lines changed

3 files changed

+765
-113
lines changed

self-hosted/docker-compose.mdx

Lines changed: 7 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,18 @@ description: Deploy DeployStack using Docker Compose for a quick and reliable se
55

66
# Docker Compose Setup
77

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.
99

1010
<Info>
1111
Docker containers are for production hosting or self-hosting. For development contributions, check the [Local Setup](/local-setup) guide.
1212
</Info>
1313

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+
1420
## Overview
1521

1622
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
2733
- **Docker & Docker Compose**: Make sure both are installed and up-to-date.
2834
- **Storage**: At least 2GB of available disk space for images and persistent data.
2935

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-
6136
## Beggining the setup for Docker Compose
6237

6338
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
188163

189164
**Note**: After initial registration, the satellite saves its API key to persistent storage and doesn't need the registration token for subsequent starts.
190165

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.
203-
</Info>
204-
205166
## Configuration
206167

207168
### External Access

0 commit comments

Comments
 (0)