summaryrefslogtreecommitdiffstats
path: root/docs/content/doc/installation
Commit message (Collapse)AuthorAgeFilesLines
* Make "install page" respect environment config (#25648) (#25799)wxiaoguang2023-07-102-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | Backport #25648 Replace #25580 Fix #19453 The problem was: when users set "GITEA__XXX__YYY" , the "install page" doesn't respect it. So, to make the result consistent and avoid surprising end users, now the "install page" also writes the environment variables to the config file. And, to make things clear, there are enough messages on the UI to tell users what will happen. There are some necessary/related changes to `environment-to-ini.go`: * The "--clear" flag is removed and it was incorrectly written there. The "clear" operation should be done if INSTALL_LOCK=true * The "--prefix" flag is removed because it's never used, never documented and it only causes inconsistent behavior. The only conflict during backport is "ui divider" in templates/install.tmpl
* docs: rootless docker ssh's default port is 2222 (#25771) (#25772)Giteabot2023-07-091-1/+1
| | | | | | | | | | | Backport #25771 by @leavesster --- according `docker/rootless/usr/local/bin/docker-setup.sh` , in rootless docker setup, ssh port is 2222. and mysql database case should port same as PostgreSQL port Co-authored-by: leavesster <11785335+leavesster@users.noreply.github.com>
* Use the new download domain replace the old (#25405) (#25409)Giteabot2023-06-218-15/+15
| | | | | | | Backport #25405 by @lunny As title. Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Add Exoscale to installation on cloud provider docs (#25342) (#25346)Giteabot2023-06-181-0/+10
| | | | | | | | | | | | | Backport #25342 by @pmig We created a Gitea application for the [Exoscale Marketplace](https://www.exoscale.com/marketplace/listing/glasskube-gitea/) for easier installation on the European cloud provider. The installation is managed via the [Glasskube Kubernetes Operator](https://github.com/glasskube/operator). Signed-off-by: Philip Miglinci <pmig@glasskube.eu> Co-authored-by: Philip Miglinci <p.miglinci@gmail.com>
* Change branch name from master to main in some documents' links (#25126) ↵HesterG2023-06-084-6/+6
| | | | | | | (#25140) Backport #25126 to 1.20 As title. And needs to backport to 1.19
* Enable all webpack sourcemaps in dev build, disable all in prod build (#25089)silverwind2023-06-061-0/+2
| | | | | | | | | | | | | | | - Enable all source maps in dev build - Disable all source maps in prod build - Provide `ENABLE_SOURCEMAP` env var to override it. I think the strange error seen in https://github.com/go-gitea/gitea/issues/24784 is sourcemap related, so if we enable/disable them all, it might go away. But it's most definitely a Safari bug. With all sourcemaps disabled, binary size goes down by around 1-2 MB, with all enabled it goes up by around 12MB. If +12MB is acceptable, we could also always enable them by default as fully source maps do have some debugging benefits.
* Remove unnecessary content on docs (#24976)Lunny Xiao2023-05-302-8/+0
|
* Unify doc links to use paths relative to doc folder (#24979)HesterG2023-05-298-16/+15
| | | | | | | | | Changes: 1. Use uniform links types relative to doc folder (start with `doc/`) 2. According to [docusaurus links](https://docusaurus.io/docs/markdown-features/links), if `<a>` is used, the `href` is resolved as URL location, but not file location. So need to use `[text]({{< relref "path" >}})` instead.
* Update from-binary.en-us.md (#24975)epk2023-05-291-1/+1
| | | Fixed link to the creating a systemd service in Ubuntu document.
* Add chinese documentations for installation (#24904)sillyguodong2023-05-256-8/+704
|
* Make environment-to-ini support loading key value from file (#24832)wxiaoguang2023-05-242-6/+24
| | | | | | | | | | | | | | | Replace #19857 Close #19856 Close #10311 Close #10123 Major changes: 1. Move a lot of code from `environment-to-ini.go` to `config_env.go` to make them testable. 2. Add `__FILE` support 3. Update documents 4. Add tests
* Updates to doc (#24757)Alejandro Leal2023-05-171-1/+1
| | | | | | | | | | | ## Misspelling fixes to: - docs/content/doc/administration/config-cheat-sheet.en-us.md - docs/content/doc/installation/from-source.en-us.md - docs/content/doc/usage/packages/cargo.en-us.md - docs/content/doc/usage/packages/storage.en-us.md --------- Co-authored-by: delvh <dev.lh@web.de>
* Docs for creating a user to run Gitea on Fedora/RHEL/CentOS (#24725)Jason Song2023-05-152-0/+24
| | | | | | | | | | The current command doesn't work on Fedora/RHEL/CentOS. - `--gecos`: use `--comment` instead. - `--group`: use `--gid` instead, `--group` means "A list of supplementary groups" on F/R/C. - `--disabled-password`: leave `--password` empty instead, "The default is to disable the password". - `--home`: use `--home-dir` and `--create-home` instead.
* Move actions as usage's subdirectory and update comparsion zh-cn version ↵Lunny Xiao2023-05-151-2/+2
| | | | | | | (#24719) As title. Co-authored-by: Giteabot <teabot@gitea.io>
* Refactor docs (#23752)John Olheiser2023-04-2841-3/+77
| | | | | | | | | | | | | | | | | | | | | | | | | | | This was intended to be a small followup for https://github.com/go-gitea/gitea/pull/23712, but...here we are. 1. Our docs currently use `slug` as the entire URL, which makes refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712). Instead, this PR attempts to make future refactoring easier by using slugs as an extension of the section. (Hugo terminology) - What the above boils down to is this PR attempts to use directory organization as URL management. e.g. `usage/comparison.en-us.md` -> `en-us/usage/comparison/`, `usage/packages/overview.en-us.md` -> `en-us/usage/packages/overview/` - Technically we could even remove `slug`, as Hugo defaults to using filename, however at least with this PR it means `slug` only needs to be the name for the **current file** rather than an entire URL 2. This PR adds appropriate aliases (redirects) for pages, so anything on the internet that links to our docs should hopefully not break. 3. A minor nit I've had for a while, renaming `seek-help` to `support`. It's a minor thing, but `seek-help` has a strange connotation to it. 4. The commits are split such that you can review the first which is the "actual" change, and the second is added redirects so that the first doesn't break links elsewhere. --------- Signed-off-by: jolheiser <john.olheiser@gmail.com>
* zh-cn support on doc pages (#24166)Kroytz2023-04-181-0/+91
| | | | + Add zh-cn support for upgrade-from-gitea page + Fix typo error on https-support.zh-cn page
* Update documentation to explain which projects allow Gitea to host static ↵65432023-04-113-3/+18
| | | | | | | | | | | | pages (#23993) close #23521 --------- Signed-off-by: 6543 <6543@obermui.de> Co-authored-by: delvh <dev.lh@web.de> Co-authored-by: a1012112796 <1012112796@qq.com> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
* Adjust some documentations titles (#23941)Lunny Xiao2023-04-064-27/+31
| | | As title.
* Update docs markdown file weight to make it clear (#23909)Lunny Xiao2023-04-0433-53/+53
| | | | For Docusaurus, it needs a meta data named `sidebar_position`, so we copy all `weight` under `menu/sidebar` as top meta key.
* 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>
generated by cgit v1.2.3 (git 2.39.1) at 2025-04-03 01:27:45 +0000