diff options
Diffstat (limited to 'docs/content/doc/installation/with-docker.en-us.md')
| -rw-r--r-- | docs/content/doc/installation/with-docker.en-us.md | 53 |
1 files changed, 36 insertions, 17 deletions
diff --git a/docs/content/doc/installation/with-docker.en-us.md b/docs/content/doc/installation/with-docker.en-us.md index c41c93288d..c476391481 100644 --- a/docs/content/doc/installation/with-docker.en-us.md +++ b/docs/content/doc/installation/with-docker.en-us.md @@ -15,13 +15,19 @@ menu: # Installation with Docker -We provide automatically updated Docker images within our Docker Hub organization. It is up to you and your deployment to always use the latest stable tag or to use another service that updates the Docker image for you. +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 you 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](https://docs.docker.com/compose/install/). +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](https://docs.docker.com/compose/install/). ## 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 you can start it only with SQLite3. Create a directory like `gitea` and paste the following content into a file named `docker-compose.yml`. +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`. ```yaml version: "2" @@ -45,7 +51,9 @@ services: ## Custom port -To bind the integrated openSSH daemon and the webserver on a different port, you just need to adjust the port section. It's common to just change the host port and keep the ports within the container like they are. +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. ```diff version: "2" @@ -71,7 +79,8 @@ services: ## MySQL database -To start Gitea in combination with a MySQL database you should apply these changes to the `docker-compose.yml` file created above. +To start Gitea in combination with a MySQL database, apply these changes to the +`docker-compose.yml` file created above. ```diff version: "2" @@ -110,7 +119,8 @@ services: ## PostgreSQL database -To start Gitea in combination with a PostgreSQL database you should apply these changes to the `docker-compose.yml` file created above. +To start Gitea in combination with a PostgreSQL database, apply these changes to +the `docker-compose.yml` file created above. ```diff version: "2" @@ -148,7 +158,9 @@ services: ## Named volumes -To use named volumes instead of host volumes you just have to define and use the named volume within the `docker-compose.yml` configuration. This change will automatically create the required volume. +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. ```diff version: "2" @@ -175,24 +187,31 @@ services: - "222:22" ``` -If you are using MySQL or PostgreSQL it's up to you to create named volumes for these containers as well. +MySQL or PostgreSQL containers will need to be created separately. ## Start -To start this setup based on `docker-compose` you just have to execute `docker-compose up -d` to launch Gitea in the background. You can see if it started properly via `docker-compose ps`, and you can tail the log output via `docker-compose logs`. +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`. -If you want to shutdown the setup again just execute `docker-compose down`, this will stop and kill the containers, the volumes will still exist. +To shut down the setup, execute `docker-compose down`. This will stop +and kill the containers. The volumes will still exist. -Notice: if you use a non 3000 port on http, you need change app.ini `LOCAL_ROOT_URL = http://localhost:3000/`. +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` you should access Gitea with your favorite browser to finalize the installation. Please visit http://server-ip:3000 and follow the installation wizard. If you have started a database with the `docker-compose` setup as documented above please note that you have to use `db` as the database hostname. +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. # Customization -Customization files described [here](https://docs.gitea.io/en-us/customizing-gitea/) should be placed in `/data/gitea` directory. If you are using host volumes it's quite easy to access these files, for named volumes you have to do it through another container or you should directly access `/var/lib/docker/volumes/gitea_gitea/_data`. The configuration file will be saved at `/data/gitea/conf/app.ini` after the installation. - -# Anything missing? - -Are we missing anything on this page? Then feel free to reach out to us on our [Discord server](https://discord.gg/NsatcWJ), there you will get answers to any question pretty fast. +Customization files described [here](https://docs.gitea.io/en-us/customizing-gitea/) 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. |