README
¶
Gogs - Go Git Service 
Gogs(Go Git Service) is a painless self-hosted Git Service written in Go.
Current version: 0.5.11 Beta
NOTICES
- Due to testing purpose, data of try.gogs.io has been reset in June 21, 2014 and will reset multiple times after. Please do NOT put your important data on the site.
- Demo site try.gogs.io is running under
devbranch.
Other language version
Purpose
The goal of this project is to make the easiest, fastest and most painless way to set up a self-hosted Git service. With Go, this can be done in independent binary distribution across ALL platforms that Go supports, including Linux, Mac OS X, and Windows.
Overview
- Please see Documentation for project design, known issues, and change log.
- See Trello Board to follow the develop team.
- Try it before anything? Do it online or go down to Installation -> Install from binary section!
- Having troubles? Get help from Troubleshooting.
- Want to help on localization? Check out Crowdin!
Features
- Activity timeline
- SSH/HTTP(S) protocol support
- SMTP/LDAP/reverse proxy authentication support
- Reverse proxy suburl support
- Register/delete/rename account
- Create/manage/delete organization with team management
- Create/fork/migrate/mirror/delete/watch/rename/transfer public/private repository
- Repository viewer/release/issue tracker
- Repository and Organization level webhooks
- Repository Git hooks
- Add/remove repository collaborators
- Gravatar and cache support
- Mail service(register, issue)
- Administration panel
- Slack webhook integration
- Drone CI integration
- Supports MySQL, PostgreSQL and SQLite3
- Social account login(GitHub, Google, QQ, Weibo)
- Multi-language support(7 languages)
System Requirements
- A cheap Raspberry Pi is powerful enough to match the minimal requirement.
- 4 CPU Cores and 1GB RAM would be the baseline for teamwork.
Installation
Make sure you install Prerequirements first.
There are 5 ways to install Gogs:
Acknowledgments
- Router and middleware mechanism of Macaron.
- Mail Service, modules design is inspired by WeTalk.
- System Monitor Status is inspired by GoBlog.
- Thanks lavachen and Rocker for designing Logo.
- Thanks gobuild.io for providing binary compile and download service.
- Thanks Crowdin for providing open source translation plan.
Contributors
- The core team of this project.
- See contributors page for full list of contributors.
- See TRANSLATORS for full list of translators.
License
This project is under the MIT License. See the LICENSE file for the full license text.
Documentation
¶
Overview ¶
Gogs(Go Git Service) is a painless self-hosted Git Service written in Go.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
modules
|
|
|
auth/ldap
package ldap provide functions & structure to query a LDAP ldap directory For now, it's mainly tested again an MS Active Directory service, see README.md for more information
|
package ldap provide functions & structure to query a LDAP ldap directory For now, it's mainly tested again an MS Active Directory service, see README.md for more information |
|
avatar
It is recommend to use this way cacheDir := "./cache" defaultImg := "./default.jpg" http.Handle("/avatar/", avatar.CacheServer(cacheDir, defaultImg))
|
It is recommend to use this way cacheDir := "./cache" defaultImg := "./default.jpg" http.Handle("/avatar/", avatar.CacheServer(cacheDir, defaultImg)) |
|
cron
Package cron implements a cron spec parser and job runner.
|
Package cron implements a cron spec parser and job runner. |
|
mahonia
This package is a character-set conversion library for Go.
|
This package is a character-set conversion library for Go. |
|
ssh
Prototype, git client looks like do not recognize req.Reply.
|
Prototype, git client looks like do not recognize req.Reply. |
|
uuid
Package uuid provides implementation of Universally Unique Identifier (UUID).
|
Package uuid provides implementation of Universally Unique Identifier (UUID). |
Click to show internal directories.
Click to hide internal directories.