Skip to content

Commit c21812b

Browse files
committed
Errand: Change video introduction, change prerequisites and add common issues of starting page.
1 parent 5c32eb4 commit c21812b

3 files changed

Lines changed: 32 additions & 8 deletions

File tree

docs/installation/debugging.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Debugging startup issues
6+
7+
## Running simplecontainer as the root
8+
Running start commands as the root user will not start and configure simplecontainer correct.
9+
```cgo
10+
smrmgr start
11+
```
12+
The command above needs to run as the user who is not root and has correct access to the `/var/run/docker.sock`.
13+
14+
## Docker socket access is not correctly configured
15+
Simplecontainer relies on the `/var/run/docker.sock` to communicate with the docker engine.
16+
17+
### Option 1: Make user owner of the socket (Temporary solution)
18+
```cgo
19+
sudo chown $USER /var/run/docker.sock
20+
```
21+
22+
### Option 2: Add user to the group that has access to the /var/run/docker.sock (Permanent solution)
23+
```cgo
24+
GROUP_NAME=$(stat -c '%G' /var/run/docker.sock)
25+
sudo usermod -aG "$GROUP_NAME" "$USER"
26+
```

docs/installation/prerequisites.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ In the background it relies on the `smrctl` and `smr` CLI and exposes to the use
3636

3737
To install smrmgr run the snippet below (it will install, under /usr/local/bin, both smr and smrctl).
3838

39+
:::warning
40+
These commands must be run as non-root user otherwise the deployment will fail.
41+
:::
42+
3943
```bash
4044
curl -sL https://smrmgr.simplecontainer.io -o smrmgr
4145
chmod +x smrmgr

docs/simplecontainer.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,6 @@ sidebar_position: 1
55

66
# Simplecontainer
77

8-
:::warning
9-
The project is in alpha version.
10-
:::
11-
12-
# Simplecontainer
138

149
**Simplecontainer** is a lightweight orchestrator for Docker containers, capable of running on a single node or managing multiple nodes in a cluster.
1510
It sits on top of a container engine and handles related resources such as containers and networks.
@@ -21,10 +16,9 @@ In summary:
2116
- Enables distributed Docker daemon orchestration
2217
- GitOps workflow for Docker containers
2318

24-
# See the simplecontainer in action.
25-
26-
<iframe src="https://www.youtube.com/embed/RTu4sj-7qeA?si=cHBtiujoQlMttjJO" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
19+
# See the simplecontainer in action with dashboard.
2720

21+
<iframe width="560" height="315" src="https://www.youtube.com/embed/KjfTljcSD4k?si=Tk9T3wujRItpcYru" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
2822

2923
## Features
3024

0 commit comments

Comments
 (0)