You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Now you need to edit the page to meet your requirements. In particular you must change the email addresses, web addresses and references to "Your Gitea Instance" to match your situation.
27
27
28
-
You absolutely must not place a general ToS or privacy statement that implies that the gitea project is responsible for your server.
28
+
You absolutely must not place a general ToS or privacy statement that implies that the Gitea project is responsible for your server.
Copy file name to clipboardExpand all lines: docs/content/doc/advanced/config-cheat-sheet.en-us.md
+11-11
Original file line number
Diff line number
Diff line change
@@ -106,7 +106,7 @@ Values containing `#` or `;` must be quoted using `` ` `` or `"""`.
106
106
### Repository - Upload (`repository.upload`)
107
107
108
108
-`ENABLED`: **true**: Whether repository file uploads are enabled
109
-
-`TEMP_PATH`: **data/tmp/uploads**: Path for uploads (tmp gets deleted on gitea restart)
109
+
-`TEMP_PATH`: **data/tmp/uploads**: Path for uploads (tmp gets deleted on Gitea restart)
110
110
-`ALLOWED_TYPES`: **\<empty\>**: Comma-separated list of allowed file extensions (`.zip`), mime types (`text/plain`) or wildcard type (`image/*`, `audio/*`, `video/*`). Empty value or `*/*` allows all types.
111
111
-`FILE_MAX_SIZE`: **3**: Max size of each file in megabytes.
112
112
-`MAX_FILES`: **5**: Max number of files per upload
@@ -184,7 +184,7 @@ The following configuration set `Content-Type: application/vnd.android.package-a
184
184
Values can be emoji alias (:smile:) or a unicode emoji.
185
185
For custom reactions, add a tightly cropped square image to public/img/emoji/reaction_name.png
186
186
-`CUSTOM_EMOJIS`: **gitea, codeberg, gitlab, git, github, gogs**: Additional Emojis not defined in the utf8 standard.
187
-
By default we support gitea (:gitea:), to add more copy them to public/img/emoji/emoji_name.png and
187
+
By default we support Gitea (:gitea:), to add more copy them to public/img/emoji/emoji_name.png and
188
188
add it to this config.
189
189
-`DEFAULT_SHOW_FULL_NAME`: **false**: Whether the full name of the users should be shown where possible. If the full name isn't set, the username will be used.
190
190
-`SEARCH_REPO_DESCRIPTION`: **true**: Whether to search within description at repository search on explore page.
@@ -240,14 +240,14 @@ The following configuration set `Content-Type: application/vnd.android.package-a
240
240
-`STATIC_URL_PREFIX`: **\<empty\>**:
241
241
Overwrite this option to request static resources from a different URL.
242
242
This includes CSS files, images, JS files and web fonts.
243
-
Avatar images are dynamic resources and still served by gitea.
243
+
Avatar images are dynamic resources and still served by Gitea.
244
244
The option can be just a different path, as in `/static`, or another domain, as in `https://cdn.example.com`.
245
245
Requests are then made as `%(ROOT_URL)s/static/css/index.css` and `https://cdn.example.com/css/index.css` respective.
246
-
The static files are located in the `public/` directory of the gitea source repository.
246
+
The static files are located in the `public/` directory of the Gitea source repository.
247
247
-`HTTP_ADDR`: **0.0.0.0**: HTTP listen address.
248
248
- If `PROTOCOL` is set to `fcgi`, Gitea will listen for FastCGI requests on TCP socket
249
249
defined by `HTTP_ADDR` and `HTTP_PORT` configuration settings.
250
-
- If `PROTOCOL` is set to `unix` or `fcgi+unix`, this should be the name of the Unix socket file to use.
250
+
- If `PROTOCOL` is set to `unix` or `fcgi+unix`, this should be the name of the Unix socket file to use. Relative paths will be made absolute against the AppWorkPath.
251
251
-`HTTP_PORT`: **3000**: HTTP listen port.
252
252
- If `PROTOCOL` is set to `fcgi`, Gitea will listen for FastCGI requests on TCP socket
253
253
defined by `HTTP_ADDR` and `HTTP_PORT` configuration settings.
@@ -272,7 +272,7 @@ The following configuration set `Content-Type: application/vnd.android.package-a
272
272
-`SSH_CREATE_AUTHORIZED_KEYS_FILE`: **true**: Gitea will create a authorized_keys file by default when it is not using the internal ssh server. If you intend to use the AuthorizedKeysCommand functionality then you should turn this off.
273
273
-`SSH_AUTHORIZED_KEYS_BACKUP`: **true**: Enable SSH Authorized Key Backup when rewriting all keys, default is true.
274
274
-`SSH_TRUSTED_USER_CA_KEYS`: **\<empty\>**: Specifies the public keys of certificate authorities that are trusted to sign user certificates for authentication. Multiple keys should be comma separated. E.g.`ssh-<algorithm> <key>` or `ssh-<algorithm> <key1>, ssh-<algorithm> <key2>`. For more information see `TrustedUserCAKeys` in the sshd config man pages. When empty no file will be created and `SSH_AUTHORIZED_PRINCIPALS_ALLOW` will default to `off`.
275
-
-`SSH_TRUSTED_USER_CA_KEYS_FILENAME`: **`RUN_USER`/.ssh/gitea-trusted-user-ca-keys.pem**: Absolute path of the `TrustedUserCaKeys` file gitea will manage. If you're running your own ssh server and you want to use the gitea managed file you'll also need to modify your sshd_config to point to this file. The official docker image will automatically work without further configuration.
275
+
-`SSH_TRUSTED_USER_CA_KEYS_FILENAME`: **`RUN_USER`/.ssh/gitea-trusted-user-ca-keys.pem**: Absolute path of the `TrustedUserCaKeys` file Gitea will manage. If you're running your own ssh server and you want to use the Gitea managed file you'll also need to modify your sshd_config to point to this file. The official docker image will automatically work without further configuration.
276
276
-`SSH_AUTHORIZED_PRINCIPALS_ALLOW`: **off** or **username, email**: \[off, username, email, anything\]: Specify the principals values that users are allowed to use as principal. When set to `anything` no checks are done on the principal string. When set to `off` authorized principal are not allowed to be set.
277
277
-`SSH_CREATE_AUTHORIZED_PRINCIPALS_FILE`: **false/true**: Gitea will create a authorized_principals file by default when it is not using the internal ssh server and `SSH_AUTHORIZED_PRINCIPALS_ALLOW` is not `off`.
278
278
-`SSH_AUTHORIZED_PRINCIPALS_BACKUP`: **false/true**: Enable SSH Authorized Principals Backup when rewriting all keys, default is true if `SSH_AUTHORIZED_PRINCIPALS_ALLOW` is not `off`.
@@ -298,7 +298,7 @@ The following configuration set `Content-Type: application/vnd.android.package-a
298
298
-`STATIC_CACHE_TIME`: **6h**: Web browser cache time for static resources on `custom/`, `public/` and all uploaded avatars. Note that this cache is disabled when `RUN_MODE` is "dev".
-`ENABLE_PPROF`: **false**: Application profiling (memory and cpu). For "web" command it listens on localhost:6060. For "serv" command it dumps to disk at `PPROF_DATA_PATH` as `(cpuprofile|memprofile)_<username>_<temporary id>`
301
-
-`PPROF_DATA_PATH`: **data/tmp/pprof**: `PPROF_DATA_PATH`, use an absolute path when you start gitea as service
301
+
-`PPROF_DATA_PATH`: **data/tmp/pprof**: `PPROF_DATA_PATH`, use an absolute path when you start Gitea as service
@@ -497,7 +497,7 @@ Certain queues have defaults that override the defaults set in `[queue]` (this o
497
497
Gitea instance and perform arbitrary actions in the name of the Gitea OS user.
498
498
This maybe harmful to you website or your operating system.
499
499
-`DISABLE_WEBHOOKS`: **false**: Set to `true` to disable webhooks feature.
500
-
-`ONLY_ALLOW_PUSH_IF_GITEA_ENVIRONMENT_SET`: **true**: Set to `false` to allow local users to push to gitea-repositories without setting up the Gitea environment. This is not recommended and if you want local users to push to gitea repositories you should set the environment appropriately.
500
+
-`ONLY_ALLOW_PUSH_IF_GITEA_ENVIRONMENT_SET`: **true**: Set to `false` to allow local users to push to gitea-repositories without setting up the Gitea environment. This is not recommended and if you want local users to push to Gitea repositories you should set the environment appropriately.
501
501
-`IMPORT_LOCAL_PATHS`: **false**: Set to `false` to prevent all users (including admin) from importing local path on server.
502
502
-`INTERNAL_TOKEN`: **\<random at every install if no uri set\>**: Secret used to validate communication within Gitea binary.
503
503
-`INTERNAL_TOKEN_URI`: **<empty>**: Instead of defining internal token in the configuration, this configuration option can be used to give Gitea a path to a file that contains the internal token (example value: `file:/etc/gitea/internal_token`)
@@ -592,7 +592,7 @@ Certain queues have defaults that override the defaults set in `[queue]` (this o
592
592
-`ALLOWED_USER_VISIBILITY_MODES`: **public,limited,private**: Set which visibility modes a user can have
593
593
-`DEFAULT_ORG_VISIBILITY`: **public**: Set default visibility mode for organisations, either "public", "limited" or "private".
594
594
-`DEFAULT_ORG_MEMBER_VISIBLE`: **false** True will make the membership of the users visible when added to the organisation.
595
-
-`ALLOW_ONLY_INTERNAL_REGISTRATION`: **false** Set to true to force registration only via gitea.
595
+
-`ALLOW_ONLY_INTERNAL_REGISTRATION`: **false** Set to true to force registration only via Gitea.
596
596
-`ALLOW_ONLY_EXTERNAL_REGISTRATION`: **false** Set to true to force registration only using third-party services.
597
597
-`NO_REPLY_ADDRESS`: **noreply.DOMAIN** Value for the domain part of the user's email address in the git log if user has set KeepEmailPrivate to true. DOMAIN resolves to the value in server.DOMAIN.
598
598
The user's email will be replaced with a concatenation of the user name in lower case, "@" and NO_REPLY_ADDRESS.
@@ -750,11 +750,11 @@ Default templates for project boards:
-`STACKTRACE_LEVEL`: **None**: Default log level at which to log create stack traces. \[Trace, Debug, Info, Warn, Error, Critical, Fatal, None\]
752
752
-`ROUTER_LOG_LEVEL`: **Info**: The log level that the router should log at. (If you are setting the access log, its recommended to place this at Debug.)
753
-
-`ROUTER`: **console**: The mode or name of the log the router should log to. (If you set this to `,` it will log to default gitea logger.)
753
+
-`ROUTER`: **console**: The mode or name of the log the router should log to. (If you set this to `,` it will log to default Gitea logger.)
754
754
NB: You must have `DISABLE_ROUTER_LOG` set to `false` for this option to take effect. Configure each mode in per mode log subsections `\[log.modename.router\]`.
755
755
-`ENABLE_ACCESS_LOG`: **false**: Creates an access.log in NCSA common log format, or as per the following template
756
756
-`ENABLE_SSH_LOG`: **false**: save ssh log to log file
757
-
-`ACCESS`: **file**: Logging mode for the access logger, use a comma to separate values. Configure each mode in per mode log subsections `\[log.modename.access\]`. By default the file mode will log to `$ROOT_PATH/access.log`. (If you set this to `,` it will log to the default gitea logger.)
757
+
-`ACCESS`: **file**: Logging mode for the access logger, use a comma to separate values. Configure each mode in per mode log subsections `\[log.modename.access\]`. By default the file mode will log to `$ROOT_PATH/access.log`. (If you set this to `,` it will log to the default Gitea logger.)
758
758
-`ACCESS_LOG_TEMPLATE`: **`{{.Ctx.RemoteAddr}} - {{.Identity}} {{.Start.Format "[02/Jan/2006:15:04:05 -0700]" }} "{{.Ctx.Req.Method}} {{.Ctx.Req.URL.RequestURI}} {{.Ctx.Req.Proto}}" {{.ResponseWriter.Status}} {{.ResponseWriter.Size}} "{{.Ctx.Req.Referer}}\" \"{{.Ctx.Req.UserAgent}}"`**: Sets the template used to create the access log.
Copy file name to clipboardExpand all lines: docs/content/doc/advanced/customizing-gitea.en-us.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -92,7 +92,7 @@ shouldn't be touched without fully understanding these components.
92
92
93
93
Copy [`home.tmpl`](https://github.com/go-gitea/gitea/blob/main/templates/home.tmpl) for your version of Gitea from `templates` to `$GITEA_CUSTOM/templates`.
94
94
Edit as you wish.
95
-
Dont forget to restart your gitea to apply the changes.
95
+
Dont forget to restart your Gitea to apply the changes.
96
96
97
97
### Adding links and tabs
98
98
@@ -248,7 +248,7 @@ $GITEA_CUSTOM/public
248
248
`-- three.min.js
249
249
```
250
250
251
-
Then restart gitea and open a STL file on your gitea instance.
251
+
Then restart Gitea and open a STL file on your Gitea instance.
252
252
253
253
## Customizing Gitea mails
254
254
@@ -338,7 +338,7 @@ Community themes are listed in [gitea/awesome-gitea#themes](https://gitea.com/gi
338
338
The `arc-green` theme source can be found [here](https://github.com/go-gitea/gitea/blob/main/web_src/less/themes/theme-arc-green.less).
339
339
340
340
If your custom theme is considered a dark theme, set the global css variable `--is-dark-theme` to `true`.
341
-
This allows gitea to adjust the Monaco code editor's theme accordingly.
341
+
This allows Gitea to adjust the Monaco code editor's theme accordingly.
Copy file name to clipboardExpand all lines: docs/content/doc/advanced/logging-documentation.en-us.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -328,13 +328,13 @@ This is equivalent to sending all logs to the console, with default go log being
328
328
## Releasing-and-Reopening, Pausing and Resuming logging
329
329
330
330
If you are running on Unix you may wish to release-and-reopen logs in order to use `logrotate` or other tools.
331
-
It is possible force gitea to release and reopen it's logging files and connections by sending `SIGUSR1` to the
331
+
It is possible force Gitea to release and reopen it's logging files and connections by sending `SIGUSR1` to the
332
332
running process, or running `gitea manager logging release-and-reopen`.
333
333
334
334
Alternatively, you may wish to pause and resume logging - this can be accomplished through the use of the
335
335
`gitea manager logging pause` and `gitea manager logging resume` commands. Please note that whilst logging
336
336
is paused log events below INFO level will not be stored and only a limited number of events will be stored.
337
-
Logging may block, albeit temporarily, slowing gitea considerably whilst paused - therefore it is
337
+
Logging may block, albeit temporarily, slowing Gitea considerably whilst paused - therefore it is
338
338
recommended that pausing only done for a very short period of time.
339
339
340
340
## Adding and removing logging whilst Gitea is running
@@ -439,6 +439,6 @@ Gitea includes built-in log rotation, which should be enough for most deployment
439
439
- Install `logrotate`.
440
440
- Configure `logrotate` to match your deployment requirements, see `man 8 logrotate` for configuration syntax details. In the `postrotate/endscript` block send Gitea a `USR1` signal via `kill -USR1` or `kill -10` to the `gitea` process itself, or run `gitea manager logging release-and-reopen` (with the appropriate environment). Ensure that your configurations apply to all files emitted by Gitea loggers as described in the above sections.
441
441
- Always do `logrotate /etc/logrotate.conf --debug` to test your configurations.
442
-
- If you are using docker and are running from outside of the container you can use `docker exec -u $OS_USER $CONTAINER_NAME sh -c 'gitea manager logging release-and-reopen'` or `docker exec $CONTAINER_NAME sh -c '/bin/s6-svc -1 /etc/s6/gitea/'` or send `USR1` directly to the gitea process itself.
442
+
- If you are using docker and are running from outside of the container you can use `docker exec -u $OS_USER $CONTAINER_NAME sh -c 'gitea manager logging release-and-reopen'` or `docker exec $CONTAINER_NAME sh -c '/bin/s6-svc -1 /etc/s6/gitea/'` or send `USR1` directly to the Gitea process itself.
443
443
444
444
The next `logrotate` jobs will include your configurations, so no restart is needed. You can also immediately reload `logrotate` with `logrotate /etc/logrotate.conf --force`.
Copy file name to clipboardExpand all lines: docs/content/doc/developers/guidelines-backend.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -104,7 +104,7 @@ i.e. `servcies/user`, `models/repository`.
104
104
### Import Alias
105
105
106
106
Since there are many package levels and sub packages, so you will find `modules/user`, `models/user`, `services/user`. When these packages are import into one Go file, it's difficult to know which package we are using and if it's a variable name or an import name. So we recommand to always use import alias. To differ from package variables which are commonly use camelCase, just use **snake_case** as import package alias.
107
-
i.e. `import user_service "code.Gitea.io/Gitea/services/user"`
107
+
i.e. `import user_service "code.gitea.io/gitea/services/user"`
0 commit comments