gitea/gitea-docs
1
0
Fork 0
mirror of https://gitea.com/gitea/docs.git synced 2026-07-01 16:44:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
827 Commits 3 Branches 5 Tags
3bf4e455d643eada52dd2b625bdbc5170bcd9c1a
Commit Graph

52 Commits

Author SHA1 Message Date
Ben Yanke
cd244d86fd Improve token and secret key generation docs (#20387) 
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>
 2022-07-30 13:28:50 +08:00
silverwind
fe1726a9e5 Add markdownlint (#20512) 
Add `markdownlint` linter and fix issues. Config is based on the one
from electron's repo with a few rules relaxed.
 2022-07-28 09:22:47 +08:00
Kevin Samuel
1ddb787537 patch (doc): add heading to ssh flow explanation (#20506) 2022-07-27 10:06:02 -04:00
wxiaoguang
095601b249 Update document to use FHS /usr/local/bin/gitea instead of /app/... for 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
 2022-05-24 14:57:15 +08:00
Stephen J. Fuhry
3c2dad837d upgrade postgres refrence to 14 (#19416) 2022-04-16 11:59:56 -04:00
mscherer
41b1bf0566 Fix documentation and #19065 (#19067) 2022-03-13 18:30:58 +01:00
zeripath
f5a7d87492 Attempt to improve docs (yet again) (#18687) 
* 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>
 2022-02-10 19:20:06 +00:00
zeripath
de2778998d Make docker gitea/gitea:v1.16-dev etc refer to the latest build on that 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>
 2022-02-03 09:47:27 +01:00
zeripath
f718e91627 Update the SSH passthrough documentation (#18366) 2022-01-23 12:25:25 -05:00
Andrey Esin
02f7ddd7a2 Fix identation typo in doc installation with Docker (#18233) 2022-01-11 19:33:42 +08:00
Greg Myers
59ef05d999 Fix typos in docs/content (#18215) 2022-01-09 19:53:03 +08:00
qwerty287
a0d1923637 Fix various typos of software names (#18083) 
* `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
 2021-12-24 11:56:57 +08:00
qwerty287
a504ca2c61 Docs: replace gitea with Gitea (#17838) 
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
 2021-11-28 21:28:30 +08:00
Mashiro
46137111f0 docs: add permission notes to SSH Container Passthrough (#17347) 
* Update with-docker.en-us.md

* Update with-docker.en-us.md

Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
 2021-10-18 12:26:47 -04:00
techknowlogick
79508a30f8 Change docker tag logic (#16421) 
* 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>
 2021-07-14 18:08:43 +01:00
Patrick Schratz
7ac0b59132 Bump postgres and mysql versions (#15710) 
* bump postgres and mysql DB versions

* posgres test against v10

Co-authored-by: 6543 <6543@obermui.de>
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
 2021-05-21 18:11:48 -04:00
Björn Heinrichs
a1ee0776a9 Fix docker enviroment variable from TYPE to DB_TYPE (#15585) 
As documented in https://docs.gitea.io/en-us/config-cheat-sheet/ the database type is defined using db_type not type.
 2021-04-22 16:34:12 +02:00
techknowlogick
0606b5253b docs: rm deprecated docs regarding environment variable usage in docker 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>
 2021-04-12 15:42:02 -04:00
Kyle D
bfd33e142b Add environment-to-ini to docker image (#14762) 
* 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
 2021-02-23 20:21:44 +01:00
Patrick Schratz
23c59242b5 update ssh passthrough (#14403) 
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
 2021-01-20 21:25:18 -05:00
Bo-Yi Wu
3c61e32468 docs(docker): fix diff format. (#14035) 
Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
 2020-12-17 00:00:43 -05:00
Patrick Schratz
9ccfa03d94 Reformat docs (#13897) 
Co-authored-by: 6543 <6543@obermui.de>
Co-authored-by: Lauris BH <lauris@nix.lv>
 2020-12-09 07:47:06 +01:00
6543
33231b3a42 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>
 2020-12-07 23:52:26 -05:00
Patrick Schratz
c03592a5e5 Update docker ssh passthrough docs (#13732) 
* 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>
 2020-12-02 18:23:54 -05:00
silverwind
1ba3ba6510 Set RUN_MODE prod by default (#13765) 
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>
 2020-11-30 14:52:04 -05:00
6543
a3b10dd83e Format files (#13698) 
* 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>
 2020-11-28 01:12:22 -05:00
techknowlogick
eda38fca6e specific version in docker compose (#13644) 
* specific version in docker compose

fix #13643

* update latest version
 2020-11-19 11:36:48 -05:00
Amoo Hesam
3d12ad10ed Inform user of how disable SSH feature when installing using Docker (#13180) 2020-10-22 00:24:20 -04:00
Patrick Schratz
650344c8b4 Align SSH_AUTHORIZED_KEYS_BACKUP var with the value in app.ini (#13212) 
* 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>
 2020-10-19 15:25:32 -04:00
Melroy van den Berg
a16760939f Improve Docker container name (#13077) 
* 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>
 2020-10-08 22:31:07 -04:00
Divyam Bhasin
dd31df0ced updated docs with caveat for authorized_keys (#13030) 
* updated docs with caveat for authorized_keys

* wrapped authorized_keys in ticks

Co-authored-by: techknowlogick <techknowlogick@gitea.io>
 2020-10-04 19:52:40 -04:00
Adrian POIGET
375c708bd1 Fix; declare DOMAIN variable for docker setup (#10780) 
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>
 2020-05-04 10:50:29 +01:00
Florian Hübner
aa08422341 add /etc/timezone and /etc/localtime volumes (#8911) 
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.
 2019-11-13 12:46:46 +00:00
leigh capili
0f07b391df Support SSH_LISTEN_PORT env var in docker app.ini template (#7829) 
Signed-off-by: leigh capili <leigh@null.net>
 2019-08-24 01:44:24 +02:00
John Olheiser
f5c4a98f2c Add config option and shortcode for Gitea version (#7940) 
Signed-off-by: jolheiser <john.olheiser@gmail.com>
 2019-08-23 09:55:06 +08:00
Marat Radchenko
0aa8555566 [docker] Add LFS_START_SERVER option to control git-lfs support (#7281) 2019-06-24 01:33:56 -04:00
John Olheiser
24d9c9a7e5 Enabled emoji in Hugo (#6521) 
Removed extra asterisks in Docker doc

Signed-off-by: jolheiser <john.olheiser@gmail.com>
 2019-04-05 18:01:38 +03:00
Aidan Fitzgerald
9853171de5 Copyedit docs (#6275) 2019-03-09 16:15:45 -05:00
Dane
af5ad171e5 Add docs on passing SSH through to container (#5019) 
* 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
 2019-01-05 12:53:23 -05:00
Ryan Halliday
0f884aaf63 Notes on upgrading docker installation (#5395) 
* 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
 2018-11-25 20:51:02 -05:00
Paul Strickland
c4bcaaf67b Update with-docker.en-us.md (#5203) 
Improve grammar in second paragraph.
 2018-10-27 23:18:55 -04:00
Dane
e1839b3c80 Add missing envionment vars for DB with Docker (#5007) 
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>
 2018-10-03 17:16:48 +03:00
Wyall
bd3f068d3f ADD: Hint to function of docker version tags (#4967) 
I wasn't sure about how tags work, maybe this is interesting for people with less knowledge of docker.
 2018-09-21 09:43:31 +08:00
Richard Coleman
2f583fd4b3 Add details about USER_UID and USER_GID environment variables (#4301) 2018-06-23 22:55:48 -04:00
Daniel Peukert
f45b1df0bf Minor 'Installation with Docker' docs page fix (#4122) 2018-06-05 02:08:56 +03:00
Fluf
ca6d9ede09 Add Environment Variables to Docker template (#4012) 
* Add disable registration as an environment variable

for docker

* Add REQUIRE_SIGNIN_VIEW as env var to docker

* Add variables to template

* Update docker docs
 2018-05-23 23:31:12 +08:00
kolaente
413c6e7250 Added explanation for docker environment variables to docs (#3804) 2018-04-17 08:56:28 +08:00
Richard Coleman
d9bf3371c7 Add info from #2286, minor fixes to YAML indentation (#3338) 
* Add info from #2286, minor fixes to YAML indentation

* Add space to make YAML valid again
 2018-02-15 19:56:10 -06:00
Michael Lustfield
3f7768d4e8 General documentation cleanup (#3317) 
* Clean up spelling, grammar, perspective, whitespace, language, markup, etc.
 2018-01-08 23:48:42 +01:00
bibaijin
8b4833b3cc add quotation around ports in docker-compose.yml (#3090) 2017-12-05 14:03:40 +08:00