diff options
| author | Unknwon <u@gogs.io> | 2017-02-18 13:53:58 -0500 |
|---|---|---|
| committer | Unknwon <u@gogs.io> | 2017-02-18 13:53:58 -0500 |
| commit | 5d766bc4d6d7a2a876b5f769b7dc85d3dfd8f7bf (patch) | |
| tree | 103db0624a5cdb8b23436b64e90790464e7fd983 /docker | |
| parent | 1083c0cd9afcdddbb0216b408841d4c45200093d (diff) | |
docker: improve README [CI SKIP]
Diffstat (limited to 'docker')
| -rw-r--r-- | docker/README.md | 22 |
1 files changed, 13 insertions, 9 deletions
diff --git a/docker/README.md b/docker/README.md index e6fa15dd..48f51e54 100644 --- a/docker/README.md +++ b/docker/README.md @@ -1,12 +1,12 @@ # Docker for Gogs -Visit [Docker Hub](https://hub.docker.com/r/gogs/) see all available images and tags. +Visit [Docker Hub](https://hub.docker.com/r/gogs/) / [Docker Store](https://store.docker.com/community/images/gogs/gogs) see all available images and tags. ## Usage 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. -``` +```sh # Pull image from Docker Hub. $ docker pull gogs/gogs @@ -36,11 +36,11 @@ Directory `/var/gogs` keeps Git repositories and Gogs data: |-- data |-- log -### Volume with data container +### Volume With Data Container If you're more comfortable with mounting data to a data container, the commands you execute at the first time will look like as follows: -``` +```sh # Create data container docker run --name=gogs-data --entrypoint /bin/true gogs/gogs @@ -48,9 +48,9 @@ docker run --name=gogs-data --entrypoint /bin/true gogs/gogs docker run --name=gogs --volumes-from gogs-data -p 10022:22 -p 10080:3000 gogs/gogs ``` -#### Using Docker 1.9 Volume command +#### Using Docker 1.9 Volume Command -``` +```sh # Create docker volume. $ docker volume create --name gogs-data @@ -67,13 +67,13 @@ Most of settings are obvious and easy to understand, but there are some settings - **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`. - **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. -- **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. **Builtin SSH server is not recommended inside Docker Container** -- **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. +- **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. **Builtin SSH server is not recommended inside Docker Container** +- **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/`). Full documentation of application settings can be found [here](https://gogs.io/docs/advanced/configuration_cheat_sheet.html). -### Container options +### Container Options This container have some options available via environment variables, these options are opt-in features that can help the administration of this container: @@ -109,3 +109,7 @@ Steps to upgrade Gogs with Docker: ## Known Issues - The docker container can not currently be build on Raspberry 1 (armv6l) as our base image `alpine` does not have a `go` package available for this platform. + +## Useful Links + +- [Share port 22 between Gogs inside Docker & the local system](http://www.ateijelo.com/blog/2016/07/09/share-port-22-between-docker-gogs-ssh-and-local-system)
\ No newline at end of file |