6.8 KiB
date | title | slug | weight | toc | draft | menu | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2016-12-01T16:00:00+02:00 | Installation with Docker | install-with-docker | 10 | true | false |
|
Installation with Docker
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
, the installation
of docker-compose
is out of scope of this documentation. To install docker-compose
follow
the official install instructions.
Basics
The most simple setup just creates a volume and a network and starts the gitea/gitea:latest
image as a service. Since there is no database available one can be initialized using SQLite3.
Create a directory like gitea
and paste the following content into a file named docker-compose.yml
.
Note that the volume should be owned by the user/group with the UID/GID specified in the config file.
If you don't give the volume correct permissions, the container may not start.
version: "2"
networks:
gitea:
external: false
services:
server:
image: gitea/gitea:latest
environment:
- USER_UID=1000
- USER_GID=1000
restart: always
networks:
- gitea
volumes:
- ./gitea:/data
ports:
- "3000:3000"
- "222:22"
Custom port
To bind the integrated openSSH daemon and the webserver on a different port, adjust the port section. It's common to just change the host port and keep the ports within the container like they are.
version: "2"
networks:
gitea:
external: false
services:
server:
image: gitea/gitea:latest
environment:
- USER_UID=1000
- USER_GID=1000
restart: always
networks:
- gitea
volumes:
- ./gitea:/data
ports:
- - "3000:3000"
- - "222:22"
+ - "8080:3000"
+ - "2221:22"
MySQL database
To start Gitea in combination with a MySQL database, apply these changes to the
docker-compose.yml
file created above.
version: "2"
networks:
gitea:
external: false
services:
server:
image: gitea/gitea:latest
environment:
- USER_UID=1000
- USER_GID=1000
restart: always
networks:
- gitea
volumes:
- ./gitea:/data
ports:
- "3000:3000"
- "222:22"
+ depends_on:
+ - db
+
+ db:
+ image: mysql:5.7
+ restart: always
+ environment:
+ - MYSQL_ROOT_PASSWORD=gitea
+ - MYSQL_USER=gitea
+ - MYSQL_PASSWORD=gitea
+ - MYSQL_DATABASE=gitea
+ networks:
+ - gitea
+ volumes:
+ - ./mysql:/var/lib/mysql
PostgreSQL database
To start Gitea in combination with a PostgreSQL database, apply these changes to
the docker-compose.yml
file created above.
version: "2"
networks:
gitea:
external: false
services:
server:
image: gitea/gitea:latest
environment:
- USER_UID=1000
- USER_GID=1000
restart: always
networks:
- gitea
volumes:
- ./gitea:/data
ports:
- "3000:3000"
- "222:22"
+ depends_on:
+ - db
+
+ db:
+ image: postgres:9.6
+ restart: always
+ environment:
+ - POSTGRES_USER=gitea
+ - POSTGRES_PASSWORD=gitea
+ - POSTGRES_DB=gitea
+ networks:
+ - gitea
+ volumes:
+ - ./postgres:/var/lib/postgresql/data
Named volumes
To use named volumes instead of host volumes, define and use the named volume
within the docker-compose.yml
configuration. This change will automatically
create the required volume. You don't need to worry about permissions with
named volumes, Docker will deal with that automatically.
version: "2"
networks:
gitea:
external: false
+volumes:
+ gitea:
+ driver: local
+
services:
server:
image: gitea/gitea:latest
restart: always
networks:
- gitea
volumes:
- - ./gitea:/data
+ - gitea:/data
ports:
- "3000:3000"
- "222:22"
MySQL or PostgreSQL containers will need to be created separately.
Start
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
.
To shut down the setup, execute docker-compose down
. This will stop
and kill the containers. The volumes will still exist.
Notice: if using a non-3000 port on http, change app.ini to match
LOCAL_ROOT_URL = http://localhost:3000/
.
Install
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
setup as
documented above please note that db
must be used as the database hostname.
Environments variables
You can configure some of Gitea's settings via environment variables:
(Default values are provided in bold)
APP_NAME
: "Gitea: Git with a cup of tea": Application name, used in the page title.RUN_MODE
: dev: For performance and other purposes, change this toprod
when deployed to a production environment.SSH_DOMAIN
: localhost: Domain name of this server, used for displayed clone UR in Gitea's UI.SSH_PORT
: 22: SSH port displayed in clone URL.DISABLE_SSH
: false: Disable SSH feature when it's not available.HTTP_PORT
: 3000: HTTP listen port.ROOT_URL
: "": Overwrite the automatically generated public URL. This is useful if the internal and the external URL don't match (e.g. in Docker).DB_TYPE
: sqlite3: The database type in use [mysql, postgres, mssql, sqlite3].DB_HOST
: localhost:3306: Database host address and port.DB_NAME
: gitea: Database name.DB_USER
: root: Database username.DB_PASSWD
: "": Database user password. Use `your password` for quoting if you use special characters in the password.INSTALL_LOCK
: false: Disallow access to the install page.SECRET_KEY
: "": Global secret key. This should be changed. If this has a value andINSTALL_LOCK
is empty,INSTALL_LOCK
will automatically set totrue
.
Customization
Customization files described here should
be placed in /data/gitea
directory. If using host volumes it's quite easy to access these
files; for named volumes this is done through another container or by direct access at
/var/lib/docker/volumes/gitea_gitea/_data
. The configuration file will be saved at
/data/gitea/conf/app.ini
after the installation.