summaryrefslogtreecommitdiffstats
path: root/docs/content/doc/installation
diff options
context:
space:
mode:
author6543 <6543@obermui.de>2020-12-08 04:52:26 +0000
committerGitHub <noreply@github.com>2020-12-07 23:52:26 -0500
commit6bdcacd73b403354aa180bfada7236038d9712b1 (patch)
tree831f00e67434304c75561df0f163b1ca51c5c157 /docs/content/doc/installation
parente7938c9c44384e044afba14d5a86b1ba32520dd3 (diff)
downloadgitea-6bdcacd73b403354aa180bfada7236038d9712b1.tar.gz
gitea-6bdcacd73b403354aa180bfada7236038d9712b1.zip
Added Table of Contents to long documentation pages (#13890)
* Redo #13836 with new shortcode (https://gitea.com/gitea/theme/pulls/90) * add Api Usage Co-authored-by: techknowlogick <techknowlogick@gitea.io>
Diffstat (limited to 'docs/content/doc/installation')
-rw-r--r--docs/content/doc/installation/database-preparation.en-us.md4
-rw-r--r--docs/content/doc/installation/from-binary.en-us.md10
-rw-r--r--docs/content/doc/installation/from-package.en-us.md2
-rw-r--r--docs/content/doc/installation/from-source.en-us.md2
-rw-r--r--docs/content/doc/installation/with-docker.en-us.md2
-rw-r--r--docs/content/doc/installation/with-docker.fr-fr.md2
-rw-r--r--docs/content/doc/installation/with-docker.zh-cn.md2
-rw-r--r--docs/content/doc/installation/with-docker.zh-tw.md2
8 files changed, 23 insertions, 3 deletions
diff --git a/docs/content/doc/installation/database-preparation.en-us.md b/docs/content/doc/installation/database-preparation.en-us.md
index df078b01df..32cfe18120 100644
--- a/docs/content/doc/installation/database-preparation.en-us.md
+++ b/docs/content/doc/installation/database-preparation.en-us.md
@@ -13,12 +13,16 @@ menu:
identifier: "database-prep"
---
+# Database Preparation
+
You need a database to use Gitea. Gitea supports PostgreSQL, MySQL, SQLite, and MSSQL. This page will guide into preparing database. Only PostgreSQL and MySQL will be covered here since those database engines are widely-used in production.
Database instance can be on same machine as Gitea (local database setup), or on different machine (remote database).
Note: All steps below requires that the database engine of your choice is installed on your system. For remote database setup, install the server part on database instance and client part on your Gitea server. In addition, make sure you use same engine version for both server and client for some engine features to work. For security reason, protect `root` (MySQL) or `postgres` (PostgreSQL) database superuser with secure password. The steps assumes that you run Linux for both database and Gitea servers.
+{{< toc >}}
+
## MySQL
1. For remote database setup, you will need to make MySQL listen to your IP address. Edit `bind-address` option on `/etc/mysql/my.cnf` on database instance to:
diff --git a/docs/content/doc/installation/from-binary.en-us.md b/docs/content/doc/installation/from-binary.en-us.md
index 794b165f63..aac10d577d 100644
--- a/docs/content/doc/installation/from-binary.en-us.md
+++ b/docs/content/doc/installation/from-binary.en-us.md
@@ -16,9 +16,13 @@ menu:
# Installation from binary
All downloads come with SQLite, MySQL and PostgreSQL support, and are built with
-embedded assets. This can be different for older releases. Choose the file matching
-the destination platform from the [downloads page](https://dl.gitea.io/gitea/), copy
-the URL and replace the URL within the commands below:
+embedded assets. This can be different for older releases.
+
+{{< toc >}}
+
+## Download
+
+Choose the file matching the destination platform from the [downloads page](https://dl.gitea.io/gitea/), copy the URL and replace the URL within the commands below:
```sh
wget -O gitea https://dl.gitea.io/gitea/{{< version >}}/gitea-{{< version >}}-linux-amd64
diff --git a/docs/content/doc/installation/from-package.en-us.md b/docs/content/doc/installation/from-package.en-us.md
index c2e0924962..91c57a80fa 100644
--- a/docs/content/doc/installation/from-package.en-us.md
+++ b/docs/content/doc/installation/from-package.en-us.md
@@ -15,6 +15,8 @@ menu:
# Installation from package
+{{< toc >}}
+
## Alpine Linux
Alpine Linux has [Gitea](https://pkgs.alpinelinux.org/packages?name=gitea&branch=edge) in its community repository which follows the latest stable version.
diff --git a/docs/content/doc/installation/from-source.en-us.md b/docs/content/doc/installation/from-source.en-us.md
index 125deb8248..5fc521204d 100644
--- a/docs/content/doc/installation/from-source.en-us.md
+++ b/docs/content/doc/installation/from-source.en-us.md
@@ -36,6 +36,8 @@ obtain the same version as our continuous integration, see the advice given in
<a href='{{< relref "doc/developers/hacking-on-gitea.en-us.md" >}}'>Hacking on
Gitea</a>
+{{< toc >}}
+
## Download
First, we must retrieve the source code. Since, the advent of go modules, the
diff --git a/docs/content/doc/installation/with-docker.en-us.md b/docs/content/doc/installation/with-docker.en-us.md
index 9f8d88d1a8..ac085e4efc 100644
--- a/docs/content/doc/installation/with-docker.en-us.md
+++ b/docs/content/doc/installation/with-docker.en-us.md
@@ -23,6 +23,8 @@ This reference setup guides users through the setup based on `docker-compose`, b
of `docker-compose` is out of scope of this documentation. To install `docker-compose` itself, follow
the official [install instructions](https://docs.docker.com/compose/install/).
+{{< toc >}}
+
## Basics
The most simple setup just creates a volume and a network and starts the `gitea/gitea:latest`
diff --git a/docs/content/doc/installation/with-docker.fr-fr.md b/docs/content/doc/installation/with-docker.fr-fr.md
index 0bce615749..418615e986 100644
--- a/docs/content/doc/installation/with-docker.fr-fr.md
+++ b/docs/content/doc/installation/with-docker.fr-fr.md
@@ -17,6 +17,8 @@ menu:
Nous fournissons des images Docker mises à jour automatiquement via le Docker Hub de notre organisation. C'est à vous, lors devotre déploiement, de vous assurez d'utiliser toujours la dernière version stable ou d'utiliser un autre service qui met à jour l'image Docker pour vous.
+{{< toc >}}
+
## Données stockées sur l'hôte
Tout d'abord, vous devez simplement récupérer l'image Docker avec la commande suivante :
diff --git a/docs/content/doc/installation/with-docker.zh-cn.md b/docs/content/doc/installation/with-docker.zh-cn.md
index add51867a3..7fe6132fb8 100644
--- a/docs/content/doc/installation/with-docker.zh-cn.md
+++ b/docs/content/doc/installation/with-docker.zh-cn.md
@@ -17,6 +17,8 @@ menu:
阅读本章之前我们已经假设您对docker已经有了解并能够正常使用docker。
+{{< toc >}}
+
我们在 Docker Hub 的 Gitea 组织中提供了自动更新的 Docker 镜像,它会保持最新的稳定版。你也可以用其它 Docker 服务来更新。首先你需要pull镜像:
```
diff --git a/docs/content/doc/installation/with-docker.zh-tw.md b/docs/content/doc/installation/with-docker.zh-tw.md
index 5d98c43a43..b4c95c1ba2 100644
--- a/docs/content/doc/installation/with-docker.zh-tw.md
+++ b/docs/content/doc/installation/with-docker.zh-tw.md
@@ -15,6 +15,8 @@ menu:
# 用 Docker 安裝
+{{< toc >}}
+
我們在 Docker Hub 提供了自動更新的映像檔,它會保持最新穩定版。根據您的部屬環境來使用最新版本或用其他服務來更新 Docker 映像檔。首先您需要下載映像檔:
```