2017-11-26 21:44:32 +00:00
|
|
|
---
|
|
|
|
|
date: "2016-11-08T16:00:00+02:00"
|
|
|
|
|
title: "Documentation"
|
|
|
|
|
slug: "documentation"
|
|
|
|
|
weight: 10
|
|
|
|
|
toc: true
|
|
|
|
|
draft: false
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# What is Gitea?
|
|
|
|
|
|
2018-01-08 22:48:42 +00:00
|
|
|
Gitea is a painless self-hosted Git service. It is similar to GitHub, Bitbucket, and Gitlab.
|
|
|
|
|
Gitea is a fork of [Gogs](http://gogs.io). See the [Gitea Announcement](https://blog.gitea.io/2016/12/welcome-to-gitea/)
|
|
|
|
|
blog post to read about the justification for a fork.
|
2017-11-26 21:44:32 +00:00
|
|
|
|
|
|
|
|
## Purpose
|
|
|
|
|
|
2018-01-08 22:48:42 +00:00
|
|
|
The goal of this project is to provide the easiest, fastest, and most painless way of setting
|
|
|
|
|
up a self-hosted Git service. With Go, this can be done with an independent binary distribution
|
|
|
|
|
across all platforms and architectures that Go supports. This support includes Linux, macOS, and
|
|
|
|
|
Windows, on architectures like amd64, i386, ARM, PowerPC, and others.
|
2017-11-26 21:44:32 +00:00
|
|
|
|
|
|
|
|
## Features
|
|
|
|
|
|
|
|
|
|
- User Dashboard
|
|
|
|
|
- Context switcher (organization or current user)
|
|
|
|
|
- Activity timeline
|
|
|
|
|
- Commits
|
|
|
|
|
- Issues
|
|
|
|
|
- Pull requests
|
|
|
|
|
- Repository creation
|
|
|
|
|
- Searchable repository list
|
2018-01-08 22:48:42 +00:00
|
|
|
- List of organizations
|
2017-11-26 21:44:32 +00:00
|
|
|
- A list of mirror repositories
|
|
|
|
|
- Issues dashboard
|
|
|
|
|
- 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
|
|
|
|
|
- Pull request dashboard
|
|
|
|
|
- Same as issue dashboard
|
|
|
|
|
- Repository types
|
|
|
|
|
- Mirror
|
|
|
|
|
- Normal
|
|
|
|
|
- Migrated
|
|
|
|
|
- Notifications (email and web)
|
|
|
|
|
- Read
|
|
|
|
|
- Unread
|
|
|
|
|
- Pin
|
|
|
|
|
- Explore page
|
|
|
|
|
- Users
|
|
|
|
|
- Repos
|
|
|
|
|
- Organizations
|
|
|
|
|
- Search
|
|
|
|
|
- Custom templates
|
|
|
|
|
- Override public files (logo, css, etc)
|
|
|
|
|
- CSRF and XSS protection
|
|
|
|
|
- HTTPS support
|
|
|
|
|
- Set allowed upload sizes and types
|
|
|
|
|
- Logging
|
|
|
|
|
- Configuration
|
|
|
|
|
- Databases
|
|
|
|
|
- MySQL
|
|
|
|
|
- PostgreSQL
|
|
|
|
|
- SQLite3
|
|
|
|
|
- MSSQL
|
2018-01-08 22:48:42 +00:00
|
|
|
- TiDB (experimental, not recommended)
|
2017-11-26 21:44:32 +00:00
|
|
|
- Configuration file
|
2018-02-18 14:38:50 +00:00
|
|
|
- [app.ini](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.ini.sample)
|
2017-11-26 21:44:32 +00:00
|
|
|
- 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
|
|
|
|
|
- People
|
|
|
|
|
- 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 somthing unexpected happens
|
|
|
|
|
- Monitoring
|
|
|
|
|
- Current processes
|
|
|
|
|
- Cron jobs
|
|
|
|
|
- Update mirrors
|
|
|
|
|
- Repository health check
|
|
|
|
|
- Check repository statstics
|
|
|
|
|
- Clean up old archives
|
|
|
|
|
- Environment variables
|
|
|
|
|
- Command line options
|
|
|
|
|
- Multi-language support ([21 languages](https://github.com/go-gitea/gitea/tree/master/options/locale))
|
|
|
|
|
- Mail service
|
|
|
|
|
- Notifications
|
|
|
|
|
- Registration confirmation
|
|
|
|
|
- Password reset
|
|
|
|
|
- Reverse proxy support
|
|
|
|
|
- Includes subpaths
|
|
|
|
|
- Users
|
|
|
|
|
- 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
|
|
|
|
|
- Mutiple email addresses
|
|
|
|
|
- SSH Keys
|
|
|
|
|
- Connected applications
|
|
|
|
|
- Two factor authentication
|
|
|
|
|
- Linked OAuth2 sources
|
|
|
|
|
- Delete account
|
|
|
|
|
- Repositories
|
|
|
|
|
- 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
|
2017-11-27 02:47:43 +00:00
|
|
|
- Track time
|
2017-12-03 23:14:26 +00:00
|
|
|
- Reactions
|
2017-11-26 21:44:32 +00:00
|
|
|
- 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
|
|
|
|
|
|
|
|
|
|
## System Requirements
|
|
|
|
|
|
2018-01-08 22:48:42 +00: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.
|
|
|
|
|
- Note: Gitea manages the `~/.ssh/authorized_keys` file. Running gitea as a regular user could break that user's ability to log in.
|
2017-11-26 21:44:32 +00:00
|
|
|
|
|
|
|
|
## Browser Support
|
|
|
|
|
|
|
|
|
|
- Please see [Semantic UI](https://github.com/Semantic-Org/Semantic-UI#browser-support) for specific versions of supported browsers.
|
|
|
|
|
|
|
|
|
|
## Components
|
|
|
|
|
|
|
|
|
|
* Web framework: [Macaron](http://go-macaron.com/)
|
|
|
|
|
* ORM: [XORM](https://github.com/go-xorm/xorm)
|
|
|
|
|
* UI components:
|
|
|
|
|
* [Semantic UI](http://semantic-ui.com/)
|
|
|
|
|
* [GitHub Octicons](https://octicons.github.com/)
|
|
|
|
|
* [Font Awesome](http://fontawesome.io/)
|
|
|
|
|
* [DropzoneJS](http://www.dropzonejs.com/)
|
|
|
|
|
* [Highlight](https://highlightjs.org/)
|
|
|
|
|
* [Clipboard](https://zenorocha.github.io/clipboard.js/)
|
|
|
|
|
* [Emojify](https://github.com/Ranks/emojify.js)
|
|
|
|
|
* [CodeMirror](https://codemirror.net/)
|
|
|
|
|
* [jQuery Date Time Picker](https://github.com/xdan/datetimepicker)
|
|
|
|
|
* [jQuery MiniColors](https://github.com/claviska/jquery-minicolors)
|
|
|
|
|
* 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/pingcap/tidb](https://github.com/pingcap/tidb)
|
|
|
|
|
* [github.com/denisenkom/go-mssqldb](https://github.com/denisenkom/go-mssqldb)
|
|
|
|
|
|
|
|
|
|
## Software and Service Support
|
|
|
|
|
|
|
|
|
|
- [Drone](https://github.com/drone/drone) (CI)
|
