summaryrefslogtreecommitdiffstats
path: root/docs/content/doc/installation/with-docker.en-us.md
Commit message (Collapse)AuthorAgeFilesLines
* Docusaurus-ify 1.20 (#26052)John Olheiser2023-07-261-647/+0
| | | | | | | | See https://github.com/go-gitea/gitea/pull/26051 --------- Signed-off-by: jolheiser <john.olheiser@gmail.com> Co-authored-by: JonRB <4564448+eeyrjmr@users.noreply.github.com>
* Correctly refer to dev tags as nightly in the docker docs (#26004) (#26019)Giteabot2023-07-201-1/+1
| | | | | | | Backport #26004 by @jolheiser As title, `dev` tags are no longer used since we switched to `nightly` Signed-off-by: jolheiser <john.olheiser@gmail.com>
* Make "install page" respect environment config (#25648) (#25799)wxiaoguang2023-07-101-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* Make environment-to-ini support loading key value from file (#24832)wxiaoguang2023-05-241-3/+12
| | | | | | | | | | | | | | | 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
* Refactor docs (#23752)John Olheiser2023-04-281-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* Update docs markdown file weight to make it clear (#23909)Lunny Xiao2023-04-041-2/+2
| | | | 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-231-1/+1
| | | | | | | | | | | | | | | | | | | | | | 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>
* Fix misc whitespace issues in install docs (#22189)Dan Church2022-12-201-19/+19
| | | | | | | | | | | | 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>
* 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>
* Add markdownlint (#20512)silverwind2022-07-281-6/+6
| | | | 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
|
* Update document to use FHS `/usr/local/bin/gitea` instead of `/app/...` for ↵wxiaoguang2022-05-241-11/+1
| | | | | | | 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
* upgrade postgres refrence to 14 (#19416)Stephen J. Fuhry2022-04-161-1/+1
|
* Fix documentation and #19065 (#19067)mscherer2022-03-131-1/+1
|
* 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-031-1/+1
| | | | | | | | | | | | | | | | 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-231-43/+199
|
* Fix identation typo in doc installation with Docker (#18233)Andrey Esin2022-01-111-3/+3
|
* Fix typos in docs/content (#18215)Greg Myers2022-01-091-1/+1
|
* Fix various typos of software names (#18083)qwerty2872021-12-241-1/+1
| | | | | | | | | | | | | | | | * `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
* Docs: replace `gitea` with `Gitea` (#17838)qwerty2872021-11-281-1/+1
| | | | Co-authored-by: wxiaoguang <wxiaoguang@gmail.com> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* 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>
* Change docker tag logic (#16421)techknowlogick2021-07-141-2/+1
| | | | | | | | | | | | | * Change docker logic * Apply suggestions from code review Co-authored-by: Kyle D. <kdumontnu@gmail.com> * docs Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: Lauris BH <lauris@nix.lv> Co-authored-by: Kyle D. <kdumontnu@gmail.com>
* Bump `postgres` and `mysql` versions (#15710)Patrick Schratz2021-05-211-2/+2
| | | | | | | | * bump postgres and mysql DB versions * posgres test against v10 Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Fix docker enviroment variable from TYPE to DB_TYPE (#15585)Björn Heinrichs2021-04-221-2/+2
| | | As documented in https://docs.gitea.io/en-us/config-cheat-sheet/ the database type is defined using db_type not type.
* docs: rm deprecated docs regarding environment variable usage in docker ↵techknowlogick2021-04-121-35/+13
| | | | | | | | | | | | image (#15405) * docs: rm deprecated docs regarding environment variable usage in docker image * Update docs/content/doc/installation/with-docker.en-us.md Co-authored-by: silverwind <me@silverwind.io> Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: silverwind <me@silverwind.io>
* Add environment-to-ini to docker image (#14762)Kyle D2021-02-231-0/+22
| | | | | | | | | | | * Add environment-to-app.ini routine * Call environment-to-ini in docker setup scripts * Automatically convert section vars to lower case to match documentation * Remove git patch instructions * Add env variable documentation to Install Docker
* update ssh passthrough (#14403)Patrick Schratz2021-01-201-7/+11
| | | Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* docs(docker): fix diff format. (#14035)Bo-Yi Wu2020-12-171-16/+16
| | | Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
* Reformat docs (#13897)Patrick Schratz2020-12-091-32/+36
| | | | Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: Lauris BH <lauris@nix.lv>
* Added Table of Contents to long documentation pages (#13890)65432020-12-071-0/+2
| | | | | | | | * Redo #13836 with new shortcode (https://gitea.com/gitea/theme/pulls/90) * add Api Usage Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Update docker ssh passthrough docs (#13732)Patrick Schratz2020-12-021-62/+41
| | | | | | | | * update docker ssh passthrough docs * remove mailto:git part in SSH forwarding call Co-authored-by: zeripath <art27@cantab.net> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Set RUN_MODE prod by default (#13765)silverwind2020-11-301-1/+1
| | | | | | | I think it's a bad default to have "dev" as the default run mode which enables debugging and now also disables HTTP caching. It's better to just default to a value suitable for general deployments. Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Format files (#13698)65432020-11-281-1/+1
| | | | | | | | | | | | | | | | * align "make help" * format * untouch build/generate-svg.js * untouch .eslintrc * combine editorconfig's * rm editorconfig Co-authored-by: Lauris BH <lauris@nix.lv> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* specific version in docker compose (#13644)techknowlogick2020-11-191-6/+6
| | | | | | | * specific version in docker compose fix #13643 * update latest version
* Inform user of how disable SSH feature when installing using Docker (#13180)Amoo Hesam2020-10-221-1/+1
|
* Align `SSH_AUTHORIZED_KEYS_BACKUP` var with the value in `app.ini` (#13212)Patrick Schratz2020-10-191-1/+1
| | | | | | | | | * Align `SSH_AUTHORIZED_KEYS_BACKUP` var with the value in `app.ini` * Also fix the cheat sheet and move it to below - SSH_CREATE_AUTHORIZED_KEYS_FILE Signed-off-by: Andrew Thornton <art27@cantab.net> Co-authored-by: Andrew Thornton <art27@cantab.net>
* Improve Docker container name (#13077)Melroy van den Berg2020-10-081-5/+13
| | | | | | | | | | | * Improve Docker container name Use a better Docker container name than the default 'server' * Changing to gitea and use recommended v3 Docker-compose Use `gitea` as container name. And use version 3 of the docker-compose, which should now be used: https://docs.docker.com/compose/compose-file/compose-versioning/ Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* updated docs with caveat for authorized_keys (#13030)Divyam Bhasin2020-10-041-1/+20
| | | | | | | * updated docs with caveat for authorized_keys * wrapped authorized_keys in ticks Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Fix; declare DOMAIN variable for docker setup (#10780)Adrian POIGET2020-05-041-2/+3
| | | | | | | | In the /install form, the value for SSH Server Domain is taken form the DOMAIN variable and overwrites SSH_DOMAIN environment variable set the first time if nothing done Co-authored-by: Adrian POIGET <adrian.poiget@viveris.fr>
* add /etc/timezone and /etc/localtime volumes (#8911)Florian Hübner2019-11-131-0/+12
| | | | Passing these volumes to the container enable gitea to use hosts localtime and timezone. This is a mandatory change when using the "Setup fail2ban" Guide, but it is not described in the documentation.
* Support SSH_LISTEN_PORT env var in docker app.ini template (#7829)leigh capili2019-08-241-0/+1
| | | Signed-off-by: leigh capili <leigh@null.net>
* Add config option and shortcode for Gitea version (#7940)John Olheiser2019-08-231-1/+1
| | | Signed-off-by: jolheiser <john.olheiser@gmail.com>
* [docker] Add LFS_START_SERVER option to control git-lfs support (#7281)Marat Radchenko2019-06-241-0/+1
|
* Enabled emoji in Hugo (#6521)John Olheiser2019-04-051-1/+1
| | | | | Removed extra asterisks in Docker doc Signed-off-by: jolheiser <john.olheiser@gmail.com>
* Copyedit docs (#6275)Aidan Fitzgerald2019-03-091-9/+9
|
* Add docs on passing SSH through to container (#5019)Dane2019-01-051-0/+64
| | | | | | | | | | | | | | | | | * Add docs on passing SSH through to container Wasn't clear how to pass SSH connections through the container, found a few blog posts which described roughly the same procedure I've documented here. Credit should really go to: * https://blog.sakuragawa.moe/gitea-in-docker-container-and-sharing-ssh-with-host/ * http://www.ateijelo.com/blog/2016/07/09/share-port-22-between-docker-gogs-ssh-and-local-system Signed-off-by: Dane Elwell <dane.elwell@ukfast.co.uk> * Add note to resolve @lafriks feedback
* Notes on upgrading docker installation (#5395)Ryan Halliday2018-11-251-0/+13
| | | | | | | | * Notes on upgrading docker installation Basis from [gogs/gogs](https://github.com/gogs/gogs/blob/master/docker/README.md) * Feedback from @sapk to use docker-compose only
* Update with-docker.en-us.md (#5203)Paul Strickland2018-10-271-2/+2
| | | Improve grammar in second paragraph.
* Add missing envionment vars for DB with Docker (#5007)Dane2018-10-031-0/+10
| | | | | | | | Current docs demonstrate how to configure a database container but don't explicitly specify that you should add additional environment variables to the Gitea container to make it use the database. This just demonstrates the changes required. Signed-off-by: Dane Elwell <dane.elwell@ukfast.co.uk>
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-24 13:29:00 +0000