2017-11-27 05:44:32 +08:00
---
date: "2016-11-08T16:00:00+02:00"
title: "Documentation"
slug: "documentation"
2018-05-01 01:54:38 +08:00
url: "/en-us/"
2017-11-27 05:44:32 +08:00
weight: 10
2020-12-09 14:47:06 +08:00
toc: false
2017-11-27 05:44:32 +08:00
draft: false
---
# What is Gitea?
2023-03-26 00:19:34 +08:00
Gitea is a painless self-hosted all-in-one software development service, it includes Git hosting, code review, team collaboration, package registry and CI/CD. It is similar to GitHub, Bitbucket and GitLab.
Gitea was forked from [Gogs ](http://gogs.io ) originally and almost all the code has been changed. See the [Gitea Announcement ](https://blog.gitea.io/2016/12/welcome-to-gitea/ )
2018-01-09 06:48:42 +08:00
blog post to read about the justification for a fork.
2017-11-27 05:44:32 +08:00
## Purpose
2018-01-09 06:48:42 +08:00
The goal of this project is to provide the easiest, fastest, and most painless way of setting
2022-07-14 19:15:35 +08:00
up a self-hosted Git service.
With Go, this can be done platform-independently across
**all platforms** which Go supports, including Linux, macOS, and Windows,
on x86, amd64, ARM and PowerPC architectures.
You can try it out using [the online demo ](https://try.gitea.io/ ).
2017-11-27 05:44:32 +08:00
## Features
- User Dashboard
2022-07-28 09:22:47 +08:00
- Context switcher (organization or current user)
- Activity timeline
- Commits
- Issues
- Pull requests
- Repository creation
- Searchable repository list
- List of organizations
- A list of mirror repositories
2017-11-27 05:44:32 +08:00
- Issues dashboard
2022-07-28 09:22:47 +08:00
- Context switcher (organization or current user)
- Filter by
- Open
- Closed
- Your repositories
- Assigned issues
- Your issues
- Repository
- Sort by
- Oldest
- Last updated
- Number of comments
2017-11-27 05:44:32 +08:00
- Pull request dashboard
2022-07-28 09:22:47 +08:00
- Same as issue dashboard
2017-11-27 05:44:32 +08:00
- Repository types
2022-07-28 09:22:47 +08:00
- Mirror
- Normal
- Migrated
2017-11-27 05:44:32 +08:00
- Notifications (email and web)
2022-07-28 09:22:47 +08:00
- Read
- Unread
- Pin
2017-11-27 05:44:32 +08:00
- Explore page
2022-07-28 09:22:47 +08:00
- Users
- Repos
- Organizations
- Search
2017-11-27 05:44:32 +08:00
- Custom templates
- Override public files (logo, css, etc)
- CSRF and XSS protection
- HTTPS support
- Set allowed upload sizes and types
- Logging
- Configuration
2022-07-28 09:22:47 +08:00
- Databases
- MySQL (>=5.7)
- PostgreSQL (>=10)
- SQLite3
- MSSQL (>=2008R2 SP3)
- TiDB (MySQL protocol)
- Configuration file
- [app.ini ](https://github.com/go-gitea/gitea/blob/main/custom/conf/app.example.ini )
- Admin panel
- Statistics
- Actions
- Delete inactive accounts
- Delete cached repository archives
- Delete repositories records which are missing their files
- Run garbage collection on repositories
- Rewrite SSH keys
- Resync hooks
- Recreate repositories which are missing
- Server status
- Uptime
- Memory
- Current # of goroutines
- And more
- User management
- Search
- Sort
- Last login
- Authentication source
- Maximum repositories
- Disable account
- Admin permissions
- Permission to create Git Hooks
- Permission to create organizations
- Permission to import repositories
- Organization management
2023-02-18 21:41:31 +08:00
- Members
2022-07-28 09:22:47 +08:00
- Teams
- Avatar
- Hooks
- Repository management
- See all repository information and manage repositories
- Authentication sources
- OAuth
- PAM
- LDAP
- SMTP
- Configuration viewer
- Everything in config file
- System notices
- When something unexpected happens
- Monitoring
- Current processes
- Cron jobs
- Update mirrors
- Repository health check
- Check repository statistics
- Clean up old archives
- Environment variables
- Command line options
2021-12-24 11:56:57 +08:00
- Multi-language support ([21 languages](https://github.com/go-gitea/gitea/tree/main/options/locale))
2022-09-14 00:33:37 +08:00
- [Mermaid ](https://mermaidjs.github.io/ ) diagrams in Markdown
- Math syntax in Markdown
2017-11-27 05:44:32 +08:00
- Mail service
2022-07-28 09:22:47 +08:00
- Notifications
- Registration confirmation
- Password reset
2017-11-27 05:44:32 +08:00
- Reverse proxy support
2022-07-28 09:22:47 +08:00
- Includes subpaths
2017-11-27 05:44:32 +08:00
- Users
2022-07-28 09:22:47 +08:00
- Profile
- Name
- Username
- Email
- Website
- Join date
- Followers and following
- Organizations
- Repositories
- Activity
- Starred repositories
- Settings
- Same as profile and more below
- Keep email private
- Avatar
- Gravatar
- Libravatar
- Custom
- Password
- Multiple email addresses
- SSH Keys
- Connected applications
- Two factor authentication
- Linked OAuth2 sources
- Delete account
2017-11-27 05:44:32 +08:00
- Repositories
2022-07-28 09:22:47 +08:00
- Clone with SSH/HTTP/HTTPS
- Git LFS
- Watch, Star, Fork
- View watchers, stars, and forks
- Code
- Branch browser
- Web based file upload and creation
- Clone urls
- Download
- ZIP
- TAR.GZ
- Web based editor
- Markdown editor
- Plain text editor
- Syntax highlighting
- Diff preview
- Preview
- Choose where to commit to
- View file history
- Delete file
- View raw
- Issues
- Issue templates
- Milestones
- Labels
- Assign issues
- Track time
- Reactions
- Filter
- Open
- Closed
- Assigned person
- Created by you
- Mentioning you
- Sort
- Oldest
- Last updated
- Number of comments
- Search
- Comments
- Attachments
- Pull requests
- Same features as issues
- Commits
- Commit graph
- Commits by branch
- Search
- Search in all branches
- View diff
- View SHA
- View author
- Browse files in commit
- Releases
- Attachments
- Title
- Content
- Delete
- Mark as pre-release
- Choose branch
- Wiki
- Import
- Markdown editor
- Settings
- Options
- Name
- Description
- Private/Public
- Website
- Wiki
- Enabled/disabled
- Internal/external
- Issues
- Enabled/disabled
- Internal/external
- External supports url rewriting for better integration
- Enable/disable pull requests
- Transfer repository
- Delete wiki
- Delete repository
- Collaboration
- Read/write/admin
- Branches
- Default branch
- Branch protection
- Webhooks
- Git Hooks
- Deploy keys
2022-06-02 12:22:42 +08:00
- Package Registries
- Composer
- Conan
- Container
- Generic
- Helm
- Maven
- NPM
- Nuget
- PyPI
- RubyGems
2017-11-27 05:44:32 +08:00
## System Requirements
2018-01-09 06:48:42 +08:00
- A Raspberry Pi 3 is powerful enough to run Gitea for small workloads.
- 2 CPU cores and 1GB RAM is typically sufficient for small teams/projects.
- Gitea should be run with a dedicated non-root system account on UNIX-type systems.
2022-07-28 09:22:47 +08:00
- Note: Gitea manages the `~/.ssh/authorized_keys` file. Running Gitea as a regular user could break that user's ability to log in.
2022-06-02 12:22:42 +08:00
- [Git ](https://git-scm.com/ ) version 2.0.0 or later is required.
2022-07-28 09:22:47 +08:00
- [Git Large File Storage ](https://git-lfs.github.com/ ) will be available if enabled and if your Git version is >= 2.1.2
- Git commit-graph rendering will be enabled automatically if your Git version is >= 2.18
2017-11-27 05:44:32 +08:00
## Browser Support
2021-03-22 12:04:19 +08:00
- Last 2 versions of Chrome, Firefox, Safari and Edge
2020-05-20 11:28:59 +08:00
- Firefox ESR
2017-11-27 05:44:32 +08:00
## Components
2022-07-28 09:22:47 +08:00
- Web server framework: [Chi ](http://github.com/go-chi/chi )
- ORM: [XORM ](https://xorm.io )
- UI frameworks:
- [jQuery ](https://jquery.com )
- [Fomantic UI ](https://fomantic-ui.com )
2022-10-02 10:13:44 +08:00
- [Vue3 ](https://vuejs.org )
2022-07-28 09:22:47 +08:00
- and various components (see package.json)
- Editors:
- [CodeMirror ](https://codemirror.net )
- [EasyMDE ](https://github.com/Ionaru/easy-markdown-editor )
- [Monaco Editor ](https://microsoft.github.io/monaco-editor )
- Database drivers:
- [github.com/go-sql-driver/mysql ](https://github.com/go-sql-driver/mysql )
- [github.com/lib/pq ](https://github.com/lib/pq )
- [github.com/mattn/go-sqlite3 ](https://github.com/mattn/go-sqlite3 )
- [github.com/denisenkom/go-mssqldb ](https://github.com/denisenkom/go-mssqldb )
2017-11-27 05:44:32 +08:00
2023-05-30 09:30:56 +08:00
## Integrated support
2017-11-27 05:44:32 +08:00
2023-05-31 02:10:51 +08:00
Please visit [Awesome Gitea ](https://gitea.com/gitea/awesome-gitea/ ) to get more third-party integrated support