forgejo/docker/README.md

74 lines
2.9 KiB
Markdown
Raw Normal View History

2015-08-17 11:38:49 +00:00
# Docker for Gogs
2015-08-18 14:29:02 +00:00
Visit [Docker Hub](https://hub.docker.com/r/gogs/gogs/) see all available tags.
## Usage
2015-08-17 11:38:49 +00:00
2015-08-18 14:29:02 +00:00
To keep your data out of Docker container, we do a volume(`/var/gogs` -> `/data`) here, and you can change it based on your situation.
```
2015-08-18 14:29:02 +00:00
# Pull image from Docker Hub.
$ docker pull gogs/gogs
# Create local directory for volume.
$ mkdir -p /var/gogs
2015-08-18 14:29:02 +00:00
# Use `docker run` for the first time.
$ docker run --name=gogs -p 10022:22 -p 10080:3000 -v /var/gogs:/data gogs/gogs
# Use `docker start` if you have stopped it.
$ docker start gogs
```
2015-08-18 14:29:02 +00:00
Files will be store in local path `/var/gogs` in my case.
2015-08-17 11:38:49 +00:00
Directory `/var/gogs` keeps Git repoistories and Gogs data:
/var/gogs
2015-08-17 07:17:18 +00:00
|-- git
2015-08-18 14:29:02 +00:00
| |-- gogs-repositories
|-- ssh
2015-08-18 14:29:02 +00:00
| |-- # ssh public/private keys for Gogs
|-- gogs
2015-08-17 07:17:18 +00:00
|-- conf
|-- data
|-- log
2015-08-18 14:29:02 +00:00
|-- templates
## Settings
2015-08-17 07:17:18 +00:00
Most of settings are obvious and easy to understand, but there are some settings can be confusing by running Gogs inside Docker:
2015-08-17 07:17:18 +00:00
2015-08-19 12:37:39 +00:00
- **Repository Root Path**: keep it as default value `/home/git/gogs-repositories` because `start.sh` already made a symbolic link for you.
- **Run User**: keep it as default value `git` because `start.sh` already setup a user with name `git`.
2015-09-21 14:44:40 +00:00
- **Domain**: fill in with Docker container IP(e.g. `192.168.99.100`). But if you want to access your Gogs instance from a different physical machine, please fill in with the hostname or IP address of the Docker host machine.
2015-08-19 12:37:39 +00:00
- **SSH Port**: Use the exposed port from Docker container. For example, your SSH server listens on `22` inside Docker, but you expose it by `10022:22`, then use `10022` for this value.
2015-08-19 12:41:42 +00:00
- **HTTP Port**: Use port you want Gogs to listen on inside Docker container. For example, your Gogs listens on `3000` inside Docker, and you expose it by `10080:3000`, but you still use `3000` for this value.
- **Application URL**: Use combination of **Domain** and **exposed HTTP Port** values(e.g. `http://192.168.99.100:10080/`).
2015-08-17 07:17:18 +00:00
2015-08-17 11:38:49 +00:00
Full documentation of settings can be found [here](http://gogs.io/docs/advanced/configuration_cheat_sheet.html).
2015-08-17 13:12:47 +00:00
2015-09-17 23:18:49 +00:00
## Upgrade
:exclamation::exclamation::exclamation:<span style="color: red">**Make sure you have volumed data to somewhere outside Docker container**</span>:exclamation::exclamation::exclamation:
Steps to upgrade Gogs with Docker:
- `docker pull gogs/gogs`
- `docker stop gogs`
- `docker rm gogs`
- Finally, create container as the first time and don't forget to do same volume and port mapping.
2015-08-18 14:29:02 +00:00
## Troubleshooting
2015-08-17 13:12:47 +00:00
2015-08-18 14:29:02 +00:00
If you see the following error:
2015-08-17 13:12:47 +00:00
```
checkVersion()] [E] Binary and template file version does not match
```
2015-08-18 16:34:11 +00:00
Run `rm -fr /var/gogs/gogs/templates/` should fix this it. Just remember to backup templates file if you have made modifications youself.
## Known Issues
- [Use ctrl+c when clone through SSH makes Docker exit unexpectedly](https://github.com/gogits/gogs/issues/1499)