tdsds.com/gitea
tdsds.com/gitea
1
1
Fork 0
mirror of https://github.com/go-gitea/gitea synced 2024-11-05 09:44:26 +00:00
Code Releases Activity
a34826b19f
gitea/docs/content/doc/help/faq.en-us.md
John Olheiser 10081f88ed
Add FAQ for markdown (#10611) 
* Add FAQ for markdown

* Expand explanation @guillep2k

Signed-off-by: jolheiser <john.olheiser@gmail.com>
2020-03-05 09:05:18 -06:00

15 KiB
Raw Blame History

date title slug weight toc draft menu
2019-04-05T16:00:00+02:00 FAQ faq 5 true false
sidebar
parent name weight identifier
help FAQ 5 faq

Frequently Asked Questions

This page contains some common questions and answers.
Also see [Support Options]({{< relref "doc/help/seek-help.en-us.md" >}})

Difference between 1.x and 1.x.x downloads

Version 1.7.x will be used for this example.
NOTE: this example applies to Docker images as well!

On our downloads page you will see a 1.7 directory, as well as directories for 1.7.0, 1.7.1, 1.7.2, 1.7.3, 1.7.4, 1.7.5, and 1.7.6.
The 1.7 and 1.7.0 directories are not the same. The 1.7 directory is built on each merged commit to the release/v1.7 branch.
The 1.7.0 directory, however, is a build that was created when the v1.7.0 tag was created.

This means that 1.x downloads will change as commits are merged to their respective branch (think of it as a separate "master" branch for each release).
On the other hand, 1.x.x downloads should never change.

How to migrate from Gogs/GitHub/etc. to Gitea

To migrate from Gogs to Gitea:

To migrate from GitHub to Gitea, you can use Gitea's built-in migration form.
In order to migrate items such as issues, pull requests, etc. you will need to input at least your username.
Example (requires login)

To migrate from Gitlab to Gitea, you can use this non-affiliated tool:
https://github.com/loganinak/MigrateGitlabToGogs

Where does Gitea store "x" file

  • WorkPath
    • Environment variable GITEA_WORK_DIR
    • Else binary location
  • AppDataPath (default for database, indexers, etc.)
    • APP_DATA_PATH from app.ini
    • Else %(WorkPath)/data
  • CustomPath (custom templates)
    • Environment variable GITEA_CUSTOM
    • Else %(WorkPath)/custom
  • HomeDir
    • Unix: Environment variable HOME
    • Windows: Environment variable USERPROFILE, else environment variables HOMEDRIVE+HOMEPATH
  • RepoRootPath
    • ROOT in app.ini
    • Else %(HomeDir)/gitea-repositories
  • INI (config file)
    • -c flag
    • Else %(CustomPath)/conf/app.ini
  • SQLite Database
    • PATH in database section of app.ini
    • Else %(AppDataPath)/gitea.db

Not seeing a clone URL or the clone URL being incorrect

There are a few places that could make this show incorrectly.

  1. If using a reverse proxy, make sure you have followed the correction directions in the [reverse proxy guide]({{< relref "doc/usage/reverse-proxies.en-us.md" >}})
  2. Make sure you have correctly set ROOT_URL in the server section of your app.ini

If certain clone options aren't showing up (HTTP/S or SSH), the following options can be checked in your app.ini

DISABLE_HTTP_GIT: if set to true, there will be no HTTP/HTTPS link
DISABLE_SSH: if set to true, there will be no SSH link
SSH_EXPOSE_ANONYMOUS: if set to false, SSH links will be hidden for anonymous users

Custom Templates not loading or working incorrectly

Gitea's custom templates must be added to the correct location or Gitea will not find and use them.
The correct path for the template(s) will be relative to the CustomPath

  1. To find CustomPath, look for Custom File Root Path in Site Administration -> Configuration
  • If that doesn't exist, you can try echo $GITEA_CUSTOM
  1. If you are still unable to find a path, the default can be calculated above
  2. Once you have figured out the correct custom path, you can refer to the [customizing Gitea]({{< relref "doc/advanced/customizing-gitea.en-us.md" >}}) page to add your template to the correct location.

Active user vs login prohibited user

In Gitea, an "active" user refers to a user that has activated their account via email.
A "login prohibited" user is a user that is not allowed to log in to Gitea anymore

Setting up logging

  • [Official Docs]({{< relref "doc/advanced/logging-documentation.en-us.md" >}})

What is Swagger?

Swagger is what Gitea uses for its API.
All Gitea instances have the built-in API, though it can be disabled by setting ENABLE_SWAGGER to false in the api section of your app.ini
For more information, refer to Gitea's [API docs]({{< relref "doc/advanced/api-usage.en-us.md" >}})

Swagger Example

Adjusting your server for public/private use

Preventing spammers

There are multiple things you can combine to prevent spammers.

  1. By only whitelisting certain domains with OpenID (see below)
  2. Setting ENABLE_CAPTCHA to true in your app.ini and properly configuring RECAPTCHA_SECRET and RECAPTCHA_SITEKEY
  3. Settings DISABLE_REGISTRATION to true and creating new users via the [CLI]({{< relref "doc/usage/command-line.en-us.md" >}}), [API]({{< relref "doc/advanced/api-usage.en-us.md" >}}), or Gitea's Admin UI

Only allow certain email domains

You can configure EMAIL_DOMAIN_WHITELIST in your app.ini under [service]

Only allow/block certain OpenID providers

You can configure WHITELISTED_URIS or BLACKLISTED_URIS under [openid] in your app.ini
NOTE: whitelisted takes precedence, so if it is non-blank then blacklisted is ignored

Issue only users

The current way to achieve this is to create/modify a user with a max repo creation limit of 0.

Restricted users

Restricted users are limited to a subset of the content based on their organization/team memberships and collaborations, ignoring the public flag on organizations/repos etc.__

Example use case: A company runs a Gitea instance that requires login. Most repos are public (accessible/browseable by all co-workers).

At some point, a customer or third party needs access to a specific repo and only that repo. Making such a customer account restricted and granting any needed access using team membership(s) and/or collaboration(s) is a simple way to achieve that without the need to make everything private.

Enable Fail2ban

Use [Fail2Ban]({{ relref "doc/usage/fail2ban-setup.md" >}}) to monitor and stop automated login attempts or other malicious behavior based on log patterns

How to add/use custom themes

Gitea supports two official themes right now, gitea and arc-green (light and dark respectively)
To add your own theme, currently the only way is to provide a complete theme (not just color overrides)

As an example, let's say our theme is arc-blue (this is a real theme, and can be found in this issue)
Name the .css file theme-arc-blue.css and add it to your custom folder in custom/pulic/css
Allow users to use it by adding arc-blue to the list of THEMES in your app.ini

SSHD vs built-in SSH

SSHD is the built-in SSH server on most Unix systems.
Gitea also provides its own SSH server, for usage when SSHD is not available.

Gitea is running slow

The most common culprit for this is loading federated avatars.
This can be turned off by setting ENABLE_FEDERATED_AVATAR to false in your app.ini
Another option that may need to be changed is setting DISABLE_GRAVATAR to true in your app.ini

Can't create repositories/files

Make sure that Gitea has sufficient permissions to write to its home directory and data directory.
See AppDataPath and RepoRootPath

Note for Arch users: At the time of writing this, there is an issue with the Arch package's systemd file including this line: ReadWritePaths=/etc/gitea/app.ini
Which makes all other paths non-writeable to Gitea.

Translation is incorrect/how to add more translations

Our translations are currently crowd-sourced on our Crowdin project
Whether you want to change a translation or add a new one, it will need to be there as all translations are overwritten in our CI via the Crowdin integration.

Hooks aren't running

If Gitea is not running hooks, a common cause is incorrect setup of SSH keys.
See SSH Issues for more information.

You can also try logging into the administration panel and running the Resynchronize pre-receive, update and post-receive hooks of all repositories. option.

SSH issues

If you cannot reach repositories over ssh, but https works fine, consider looking into the following.

First, make sure you can access Gitea via SSH.
ssh git@myremote.example

If the connection is successful, you should receive an error message like the following:

Hi there, You've successfully authenticated, but Gitea does not provide shell access.
If this is unexpected, please log in with password and setup Gitea under another user.

If you do not get the above message but still connect, it means your SSH key is not being managed by Gitea. This means hooks won't run, among other potential problems.

If you cannot connect at all, your SSH key may not be configured correctly locally. This is specific to SSH and not Gitea, so will not be covered here.

SSH Common Errors

Permission denied (publickey).
fatal: Could not read from remote repository.

This error signifies that the server rejected a log in attempt, check the following things:

  • On the client:
    • Ensure the public and private ssh keys are added to the correct Gitea user.
    • Make sure there are no issues in the remote url. In particular, ensure the name of the git user (before the @) is spelled correctly.
    • Ensure public and private ssh keys are correct on client machine.
  • On the server:
    • Make sure the repository exists and is correctly named.
    • Check the permissions of the .ssh directory in the system user's home directory.
    • Verify that the correct public keys are added to .ssh/authorized_keys.
      Try to run Rewrite '.ssh/authorized_keys' file (for Gitea SSH keys) on the Gitea admin panel.
    • Read Gitea logs.
    • Read /var/log/auth (or similar).
    • Check permissions of repositories.

The following is an example of a missing public SSH key where authentication succeeded, but some other setting is preventing SSH from reaching the correct repository.

fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.

In this case, look into the following settings:

  • On the server:
    • Make sure that the git system user has a usable shell set
      • Verify this with getent passwd git | cut -d: -f7
      • usermod or chsh can be used to modify this.
    • Ensure that the gitea serv command in .ssh/authorized_keys uses the correct configuration file.

Missing releases after migrating repository with tags

To migrate an repository with all tags, you need to do two things:

  • Push tags to the repository:
 git push --tags
  • (Re-)sync tags of all repositories within Gitea:
gitea admin repo-sync-releases

LFS Issues

For issues concerning LFS data upload

batch response: Authentication required: Authorization error: <GITEA_LFS_URL>/info/lfs/objects/batch                                                                                                              
Check that you have proper access to the repository
error: failed to push some refs to '<GIT_REPO_URL>'

Check the value of LFS_HTTP_AUTH_EXPIRY in your app.ini file.
By default, your LFS token will expire after 20 minutes. If you have a slow connection or a large file (or both), it may not finish uploading within the time limit.

You may want to set this value to 60m or 120m.

How can I create users before starting Gitea

Gitea provides a sub-command gitea migrate to initialize the database, after which you can use the [admin CLI commands]({{< relref "doc/usage/command-line.en-us.md#admin" >}}) to add users like normal.

How can I enable password reset

There is no setting for password resets. It is enabled when a [mail service]({{< relref "doc/usage/email-setup.en-us.md" >}}) is configured, and disabled otherwise.

How can a user's password be changed

  • As an admin, you can change any user's password (and optionally force them to change it on next login)...
    • By navigating to your Site Administration -> User Accounts page and editing a user.
    • By using the [admin CLI commands]({{< relref "doc/usage/command-line.en-us.md#admin" >}}).
      Keep in mind most commands will also need a [global flag]({{< relref "doc/usage/command-line.en-us.md#global-options" >}}) to point the CLI at the correct configuration.
  • As a user you can change it...
    • In your account Settings -> Account page (this method requires you to know your current password).
    • By using the Forgot Password link.
      If the Forgot Password/Account Recovery page is disabled, please contact your administrator to configure a [mail service]({{< relref "doc/usage/email-setup.en-us.md" >}}).

Why is my markdown broken

In Gitea version 1.11 we moved to goldmark for markdown rendering, which is CommonMark compliant.
If you have markdown that worked as you expected prior to version 1.11 and after upgrading it's not working anymore, please look through the CommonMark spec to see whether the problem is due to a bug or non-compliant syntax.
If it is the latter, usually there is a compliant alternative listed in the spec.