mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-12 12:54:12 +00:00
Updated various docker compose commands & references (#361)
Co-authored-by: wxiaoguang <[email protected]> Co-authored-by: kmanwar89 <[email protected]> Co-committed-by: kmanwar89 <[email protected]>
This commit is contained in:
1 parent
1568bfa1e9
commit
9cc5cfd388
4 files changed
+79
-469
No files matched your search
@@ -6,15 +6,22 @@ aliases:
|
||||
- /en-us/install-with-docker
|
||||
---
|
||||
|
||||
# Installation with Docker
|
||||
# Installation with Docker (rootful)
|
||||
|
||||
Gitea provides automatically updated Docker images within its Docker Hub organization. It is
|
||||
possible to always use the latest stable tag or to use another service that handles updating
|
||||
Docker images.
|
||||
|
||||
This reference setup guides users through the setup based on docker `compose`-plugin, but the installation
|
||||
of the docker `compose`-plugin is out of scope of this documentation. To install the docker `compose`-plugin itself, follow
|
||||
the official [install instructions](https://docs.docker.com/compose/install/).
|
||||
This reference setup guides users through the setup based on `docker compose`.
|
||||
Docker compose has been included in the Docker Engine since the shift to Compose v2.
|
||||
If, for some reason, compose is not available on your system, follow the official [install instructions](https://docs.docker.com/compose/install/).
|
||||
|
||||
This document targets for the default rootful image. For the rootless image,
|
||||
see "[Installation with Docker (rootless)](./with-docker-rootless.md)"
|
||||
|
||||
ATTENTION: the rootful/rootless images are not compatible with the other.
|
||||
If you have chosen one, you should always use the same one,
|
||||
don't switch to the other one by changing the compose file's `image` value.
|
||||
|
||||
## Basics
|
||||
|
||||
@@ -217,13 +224,7 @@ MySQL or PostgreSQL containers will need to be created separately.
|
||||
|
||||
## Startup
|
||||
|
||||
:::note
|
||||
From July 2023 Compose V1 stopped receiving updates. It's also no longer available in new releases of Docker Desktop.
|
||||
|
||||
Compose V2 is included with all currently supported versions of Docker Desktop. Please use V2 to do below operations.
|
||||
:::
|
||||
|
||||
To start this setup based on the docker `compose`-plugin, execute `docker compose up -d`,
|
||||
To start this setup based on `docker compose`, execute `docker compose up -d`,
|
||||
to launch Gitea in the background. Using `docker compose ps` will show if Gitea
|
||||
started properly. Logs can be viewed with `docker compose logs`.
|
||||
|
||||
@@ -237,9 +238,9 @@ If using a non-3000 port on http, change app.ini to match
|
||||
|
||||
## Installation
|
||||
|
||||
After starting the Docker setup via the docker `compose`-plugin, Gitea should be available using a
|
||||
After starting the Docker setup via `docker compose`, Gitea should be available using a
|
||||
favorite browser to finalize the installation. Visit http://server-ip:3000 and follow the
|
||||
installation wizard. If the database was started with the docker `compose`-plugin setup as
|
||||
installation wizard. If the database was started with the `docker compose` setup as
|
||||
documented above, please note that `db` must be used as the database hostname.
|
||||
|
||||
## Configure the user inside Gitea using environment variables
|
||||
@@ -277,8 +278,10 @@ docker compose up -d
|
||||
## Managing Deployments With Environment Variables
|
||||
|
||||
In addition to the environment variables above, any settings in `app.ini` can be set
|
||||
or overridden with an environment variable of the form: `GITEA__<section>__<KEY>`.
|
||||
These settings are applied each time the docker container starts, and won't be passed into Gitea's sub-processes.
|
||||
or overridden with an environment variable of the form: `GITEA__section_name__KEY_NAME=value`.
|
||||
These settings are applied each time the docker container starts by `environment-to-ini` command
|
||||
(a warpper of `gitea config edit-ini`), and won't be passed into Gitea's sub-processes.
|
||||
See `./gitea config edit-ini --help` for more details.
|
||||
|
||||
These environment variables can be passed to the docker container in `docker-compose.yml`.
|
||||
The following example will enable an smtp mail server if the required env variables
|
||||
@@ -321,5 +324,6 @@ services:
|
||||
```
|
||||
|
||||
### SSH with multiple IP addresses
|
||||
|
||||
This assumes that the host machine has more than one reachable IP address: `192.168.1.1` (host) `192.168.1.2` (gitea)
|
||||
On the host machine, configure SSHD in `/etc/ssh/sshd_config` to listen on one IP address `ListenAddress 192.168.1.1`. In the compose file the SSH port forwarding then needs to be changed to `"192.168.1.2:22:22"`. The port forwarding needs to be adjusted similarily for all other forwarded ports to avoid problems with DNS.
|
||||
Reference in new issue
Block a user