Skip to content

Commit a3c09fb

Browse files
Xinyu Zhoutechknowlogick
Xinyu Zhou
andauthored
Improve docker rootless documentation (#21913)
Emphasize folder creation/permission granting Signed-off-by: Xinyu Zhou <i@sourcehut.net> Signed-off-by: Xinyu Zhou <i@sourcehut.net> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
1 parent 787f6c3 commit a3c09fb

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

docs/content/doc/installation/with-docker-rootless.en-us.md

+20-4
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,16 @@ the official [install instructions](https://docs.docker.com/compose/install/).
2929

3030
The most simple setup just creates a volume and a network and starts the `gitea/gitea:latest-rootless`
3131
image as a service. Since there is no database available, one can be initialized using SQLite3.
32-
Create a directory for `data` and `config` then paste the following content into a file named `docker-compose.yml`.
33-
Note that the volume should be owned by the user/group with the UID/GID specified in the config file. By default Gitea in docker will use uid:1000 gid:1000. If needed you can set ownership on those folders with the command: `sudo chown 1000:1000 config/ data/`
34-
If you don't give the volume correct permissions, the container may not start.
35-
For a stable release you could use `:latest-rootless`, `:1-rootless` or specify a certain release like `:{{< version >}}-rootless`, but if you'd like to use the latest development version then `:dev-rootless` would be an appropriate tag. If you'd like to run the latest commit from a release branch you can use the `:1.x-dev-rootless` tag, where x is the minor version of Gitea. (e.g. `:1.16-dev-rootless`)
32+
33+
Create a directory for `data` and `config`:
34+
35+
```sh
36+
mkdir -p gitea/{data,config}
37+
cd gitea
38+
touch docker-compose.yml
39+
```
40+
41+
Then paste the following content into a file named `docker-compose.yml`:
3642

3743
```yaml
3844
version: "2"
@@ -51,6 +57,16 @@ services:
5157
- "2222:2222"
5258
```
5359
60+
Note that the volume should be owned by the user/group with the UID/GID specified in the config file. By default Gitea in docker will use uid:1000 gid:1000. If needed you can set ownership on those folders with the command:
61+
62+
```sh
63+
sudo chown 1000:1000 config/ data/
64+
```
65+
66+
> If you don't give the volume correct permissions, the container may not start.
67+
68+
For a stable release you could use `:latest-rootless`, `:1-rootless` or specify a certain release like `:{{< version >}}-rootless`, but if you'd like to use the latest development version then `:dev-rootless` would be an appropriate tag. If you'd like to run the latest commit from a release branch you can use the `:1.x-dev-rootless` tag, where x is the minor version of Gitea. (e.g. `:1.16-dev-rootless`)
69+
5470
## Custom port
5571

5672
To bind the integrated ssh and the webserver on a different port, adjust

0 commit comments

Comments
 (0)