summaryrefslogtreecommitdiffstats
path: root/docs/content/doc/installation
Commit message (Collapse)AuthorAgeFilesLines
* Restructure documentation. Now the documentation has installation, ↵Lunny Xiao2023-03-2317-13/+845
| | | | | | | | | | | | | | | | | | | | | | administration, usage, development, contributing the 5 main parts (#23629) - **Installation**: includes how to install Gitea and related other tools, also includes upgrade Gitea - **Administration**: includes how to configure Gitea, customize Gitea and manage Gitea instance out of Gitea admin UI - **Usage**: includes how to use Gitea's functionalities. A sub documentation is about packages, in future we could also include CI/CD and others. - **Development**: includes how to integrate with Gitea's API, how to develop new features within Gitea - **Contributing**: includes how to contribute code to Gitea repositories. After this is merged, I think we can have a sub-documentation of `Usage` part named `Actions` to describe how to use Gitea actions --------- Co-authored-by: John Olheiser <john.olheiser@gmail.com>
* Move pidfile creation from setting to web cmd package (#23285)Lunny Xiao2023-03-161-1/+1
| | | | | | | | | | | | Creating pid file should not belong to setting package and only web command needs that. So this PR moves pidfile creation from setting package to web command package to keep setting package more readable. I marked this as `break` because the PIDFile path moved. For those who have used the pid build argument, it has to be changed. --------- Co-authored-by: KN4CK3R <admin@oldschoolhack.me>
* Add Bash and Zsh completion scripts (#22646)zeripath2023-02-212-0/+20
| | | | | | | | | | | | | | | | | | | | | | | This PR adds contrib scripts for bash and zsh completion. Simply call: ```bash source contrib/autocompletion/bash_autocomplete ``` or for Zsh: ```bash source contrib/autocompletion/zsh_autocomplete ``` Signed-off-by: Andrew Thornton <art27@cantab.net> --------- Signed-off-by: Andrew Thornton <art27@cantab.net> Co-authored-by: a1012112796 <1012112796@qq.com> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* docs: Update translation from-binary.zh-cn.md (#22820)Xinyu Zhou2023-02-132-11/+142
| | | | Signed-off-by: Xinyu Zhou <i@sourcehut.net> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Grammar fix (#22790)Peyton Duncan2023-02-061-1/+1
| | | Noticed a minor grammatical error.
* Add Gentoo to the from package providers (#22284)JonRB2022-12-301-0/+8
| | | Signed-off-by: Jonathan Roadley-Battin <jon.roadleybattin@gmail.com>
* Fix misc whitespace issues in install docs (#22189)Dan Church2022-12-203-48/+48
| | | | | | | | | | | | I ran into issues when copy-pasting the docker-compose.yml contents from https://docs.gitea.io/en-us/install-with-docker/ - specifically the part about adding PostgreSQL to the YAML file; I tried manually adding the diffs by removing the `+` at the beginning of lines, and the resulting YAML was unparsable. This forces the indentation to be consistent across all places where YAML is used. Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Fix markdown typo of an extra backtick in docs (#22123)Yakov57762022-12-131-1/+1
| | | Fixes a visual bug in docs which is caused by a typo of an extra backtick.
* Improve docker rootless documentation (#21913)Xinyu Zhou2022-11-231-4/+20
| | | | | | | | Emphasize folder creation/permission granting Signed-off-by: Xinyu Zhou <i@sourcehut.net> Signed-off-by: Xinyu Zhou <i@sourcehut.net> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Fix "build from source" document to clarify the `bindata` tag is required. ↵wxiaoguang2022-11-181-6/+5
| | | | (#21853)
* Attempt clarify AppWorkPath etc. (#21656)zeripath2022-11-091-8/+8
| | | | | | | | | | Attempt clarify the AppWorkPath in the documentation by using different notation and adding a section to the start of the cheat sheet. Fix #21523 Signed-off-by: Andrew Thornton <art27@cantab.net> Signed-off-by: Andrew Thornton <art27@cantab.net>
* Fix typo (#21695)Xinyu Zhou2022-11-072-2/+2
| | | | | | Duplicate parentheses written in link. Signed-off-by: Xinyu Zhou <i@sourcehut.net> Co-authored-by: Lauris BH <lauris@nix.lv>
* Fix docs relref (#21685)Xinyu Zhou2022-11-042-2/+2
| | | | reslove https://github.com/go-gitea/gitea/issues/21627#issuecomment-1303678781
* Refactor docs (#21627)Xinyu Zhou2022-10-314-3/+3
| | | | | | | | | | | | | | This patch: - Rename some files( `.md` to `.en-us.md`), fix missed translation copy - Update link which shoud be refer to `../hacking-on-gitea/` instead of `../make/` (outdated) - Update `_redirects`: - redirect `/{zh-cn|fr-fr}/make/` to `../hacking-on-gitea/` - redirect `/zh-cn/third-party-tools/` to `/zh-cn/integrations/` - Delete duplicated/outdated files. - Update menu `weight` of developers.zh-cn.md Signed-off-by: Xinyu Zhou <i@sourcehut.net>
* Update macOS install command (#21507)RainboWu2022-10-191-1/+1
| | | Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Make app.ini read-only message more prominent (#21315)John Olheiser2022-10-021-6/+6
|
* Fix various typos (#21103)luzpaz2022-09-071-2/+2
| | | | | | | Found via `codespell -q 3 -S ./options/locale,./options/license,./public/vendor,./web_src/fomantic -L actived,allways,attachements,ba,befores,commiter,pullrequest,pullrequests,readby,splitted,te,unknwon` Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Fix typo (#21004)ya2022-08-311-2/+2
| | | | | Missing directory Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Add instructions how to add service dependencies (#20968)JonRB2022-08-281-0/+10
|
* docs[zh-cn]: Install on Kubernetes (#20874)xinyu2022-08-241-0/+82
| | | Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* docs[zh-cn]: Managing Deployments With Environment Variables (#20817)xinyu2022-08-171-11/+47
| | | Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Update zh-cn translation for Installation from source (#20772)PEN²2022-08-141-12/+34
| | | Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Fix typos in backup documentation (#20567)tryfail2022-08-011-4/+4
| | | Fixed multiple typos "/user/local/bin" to the proper path "/usr/local/bin"
* Improve token and secret key generation docs (#20387)Ben Yanke2022-07-301-1/+17
| | | | | This PR proposes a minor improvement to the docs which allows a user to paste a single command into their terminal and get the needed tokens and keys. Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
* Added guidance on file to choose to download (#20474)Alex Papadimoulis2022-07-291-1/+17
| | | | | | | | | | | | | | | | * Added guidance on file to choose to download * Update from-binary.en-us.md * Update from-binary.en-us.md * Update from-binary.en-us.md * Update docs/content/doc/installation/from-binary.en-us.md * Update docs/content/doc/installation/from-binary.en-us.md Co-authored-by: wxiaoguang <wxiaoguang@gmail.com> Co-authored-by: 6543 <6543@obermui.de>
* Add markdownlint (#20512)silverwind2022-07-2812-50/+62
| | | | Add `markdownlint` linter and fix issues. Config is based on the one from electron's repo with a few rules relaxed.
* patch (doc): add heading to ssh flow explanation (#20506)Kevin Samuel2022-07-271-0/+2
|
* Correct code block in installation docs for Snap (#20440)Andrew Imeson2022-07-221-2/+2
| | | | | Without this, it was rendering on the site like: "sh snap install gitea", instead of: "snap install gitea" Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
* Fix English mistakes in some Markdown documents (#20274)Jeremy2022-07-141-28/+38
|
* Update document to use FHS `/usr/local/bin/gitea` instead of `/app/...` for ↵wxiaoguang2022-05-242-15/+5
| | | | | | | Docker (#19794) * Update document to use FHS `/usr/local/bin/gitea` instead of `/app/...` in Docker * Update docs/content/doc/installation/with-docker.zh-cn.md
* Add health check endpoint (#18465)ttys32022-05-042-0/+88
| | | | | | | | | | | | | | | | | | | | | | | | | | | | * chore: add health check endpoint docs: update document about health check fix: fix up Sqlite3 ping. current ping will success even if the db file is missing fix: do not expose privacy information in output field * refactor: remove HealthChecker struct * Added `/api/healthz` to install routes. This was needed for using /api/healthz endpoint in Docker healthchecks, otherwise, Docker would never become healthy if using healthz endpoint and users would not be able to complete the installation of Gitea. * Update modules/cache/cache.go * fine tune * Remove unnecessary test code. Now there are 2 routes for installation (and maybe more in future) Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com> Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: Marcos de Oliveira <marcossantos@furb.br>
* Upgrade required git version to 2.0 (#19577)wxiaoguang2022-05-021-1/+2
| | | | | * Upgrade required git version to 2.0 * update document
* Fix two typos (#19504)Lunny Xiao2022-04-261-1/+1
|
* upgrade postgres refrence to 14 (#19416)Stephen J. Fuhry2022-04-163-3/+3
|
* Fix documentation and #19065 (#19067)mscherer2022-03-131-1/+1
|
* Update on-cloud-provider.md (#18807)Nicolas Ferrari2022-02-181-0/+6
|
* Attempt to improve docs (yet again) (#18687)zeripath2022-02-101-34/+123
| | | | | | | | | | | | | | | | | | | | * Attempt to improve docs (yet again) Attempt to make the passthrough docs clearer. Add some more faq entries Signed-off-by: Andrew Thornton <art27@cantab.net> * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: Gusted <williamzijl7@hotmail.com> * Update docs/content/doc/installation/with-docker.en-us.md * Update docs/content/doc/installation/with-docker.en-us.md Co-authored-by: Gusted <williamzijl7@hotmail.com>
* Make docker gitea/gitea:v1.16-dev etc refer to the latest build on that ↵zeripath2022-02-032-2/+2
| | | | | | | | | | | | | | | | branch (#18551) * Make docker gitea/gitea:v1.16-dev etc refer to the latest build on that branch One of the problems with our current docker tagging is that although we have strict version tags, latest and dev we do not have a way for docker users to track the current release branch. This PR simply suggests that we use the 1.x-dev tag for these and we build and push these. This will give users who want or need unreleased bug fixes the option of tracking the pre-release version instead of simply jumping to dev. Signed-off-by: Andrew Thornton <art27@cantab.net> Co-authored-by: KN4CK3R <admin@oldschoolhack.me> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Update the SSH passthrough documentation (#18366)zeripath2022-01-232-43/+206
|
* Fix identation typo in doc installation with Docker (#18233)Andrey Esin2022-01-112-6/+6
|
* Fix typos in docs/content (#18215)Greg Myers2022-01-091-1/+1
|
* docs: add various ways to install from package (#18120)Tony2021-12-301-7/+78
| | | | | | zh-cn Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
* Fix various typos of software names (#18083)qwerty2872021-12-246-14/+14
| | | | | | | | | | | | | | | | * `git` -> `Git` * `Github` and `github` -> `GitHub` * `crowdin` -> `Crowdin` * `git-lfs` -> `Git LFS` * `githooks`, `git hooks`, `git-hooks` -> `Git Hooks` * `discord` -> `Discord` * `2fa` -> `2FA` * `gitlab` and `Gitlab` -> `GitLab` * `web hook` -> `webhook` * `linux` -> `Linux` * `sqlite` -> `SQLite` * `MYSQL` and `mysql` -> `MySQL` * rename refs to `master` branch -> `main` * Fix English grammar
* Fix various typos in docs (#17844)qwerty2872021-11-281-1/+1
|
* Docs: replace `gitea` with `Gitea` (#17838)qwerty2872021-11-283-9/+9
| | | | Co-authored-by: wxiaoguang <wxiaoguang@gmail.com> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* fix typo (#17614)缘生2021-11-141-1/+3
|
* docs: add SSH passthrough instructions to with-docker-rootless (#17505) (#17508)Renato Caldas2021-11-011-3/+38
| | | The passthrough is based upon AuthorizedKeysCommand and a custom shell wrapper that forwards commands to the container over the docker pipe.
* docs: add permission notes to `SSH Container Passthrough` (#17347)Mashiro2021-10-181-0/+7
| | | | | | | * Update with-docker.en-us.md * Update with-docker.en-us.md Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
* Add minimum versions of databases to the docs (#17080)zeripath2021-09-171-1/+1
| | | | | | | | | | We do not currently state the minimum versions of databases we support. This PR sets them to: * MySQL >=5.7 * Postgres >=10 * MSSQL >=2008R2 SP3 Signed-off-by: Andrew Thornton <art27@cantab.net>
* Add Linode as an installation option in docs (#16529)techknowlogick2021-07-241-3/+9
| | | | | | Add Linode as an installation option in docs Co-authored-by: zeripath <art27@cantab.net>
generated by cgit v1.2.3 (git 2.39.1) at 2025-02-05 21:21:58 +0000