README
¶
Gogs - Go Git Service 
Gogs(Go Git Service) is a Self Hosted Git Service in the Go Programming Language.
NOTICES
- Due to testing purpose, data of try.gogits.org has been reset in April 14, 2014 and will reset multiple times after. Please do NOT put your important data on the site.
- Demo site try.gogits.org is running under
devbranch.
Other language version
Purpose
Since we choose to use pure Go implementation of Git manipulation, Gogs certainly supports ALL platforms that Go supports, including Linux, Mac OS X, and Windows with ZERO dependency.
More importantly, Gogs only needs one binary to setup your own project hosting on the fly!
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.
Features
- Activity timeline
- SSH/HTTP(S) protocol support
- SMTP/LDAP authentication support
- Register/delete/rename account
- Create/migrate/mirror/delete/watch/rename/transfer public/private repository
- Repository viewer/release/issue tracker/webhooks
- Add/remove repository collaborators
- Gravatar and cache support
- Mail service(register, issue)
- Administration panel
- Supports MySQL, PostgreSQL and SQLite3
- Social account login(GitHub, Google, QQ, Weibo)
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:
- Install from binary: STRONGLY RECOMMENDED
- Install from source
- Install from packages
- Ship with Docker
- Install with Vagrant
Acknowledgments
- Router and middleware mechanism of martini.
- Mail Service, modules design is inspired by WeTalk.
- System Monitor Status is inspired by GoBlog.
- Usage and modification from beego modules.
- Thanks lavachen and Rocker for designing Logo.
- Thanks gobuild.io for providing binary compile and download service.
- Great thanks to Docker China for providing dockerfiles.
Contributors
The core team of this project. See contributors page for full list of contributors.
[
][koding]
[koding]: https://koding.com/Teamwork?import=https://github.com/gogits/gogs/archive/master.zip&c=git1
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 Self Hosted Git Service in the Go Programming Language.
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)) |
|
log
Package log is a wrapper of logs for short calling name.
|
Package log is a wrapper of logs for short calling name. |
|
middleware
foked from https://github.com/martini-contrib/render/blob/master/render.go
|
foked from https://github.com/martini-contrib/render/blob/master/render.go |