|
|
@@ -10,12 +10,11 @@
|
|
|
||||
|
|
|
||||
|
|
|
|
|
|
-### Important Notes
|
|
|
+### ⚠️ Important notes ⚠️
|
|
|
|
|
|
-1. **YOU MUST READ [Contributing Code](https://github.com/gogs/gogs/wiki/Contributing-Code) BEFORE STARTING TO WORK ON A PULL REQUEST**.
|
|
|
-2. Due to testing purpose, data of [try.gogs.io](https://try.gogs.io) was reset in **Jan 28, 2015** and will reset multiple times after. Please do **NOT** put your important data on the site.
|
|
|
-3. The demo site [try.gogs.io](https://try.gogs.io) is running under `master` branch.
|
|
|
-4. If you're interested in using APIs, we have experimental support with [documentation](https://github.com/gogs/go-gogs-client/wiki).
|
|
|
+1. Due to testing purpose, data of [try.gogs.io](https://try.gogs.io) was reset in **Jan 28, 2015** and will reset multiple times after. Please do **NOT** put your important data on the site.
|
|
|
+2. The demo site [try.gogs.io](https://try.gogs.io) is running `master` branch.
|
|
|
+3. If you're interested in using APIs, we have experimental support with [documentation](https://github.com/gogs/go-gogs-client/wiki).
|
|
|
|
|
|
[简体中文](README_ZH.md)
|
|
|
|
|
|
@@ -25,10 +24,11 @@ The Gogs (`/gɑgz/`) project aims to build a simple, stable and extensible self-
|
|
|
|
|
|
## Overview
|
|
|
|
|
|
-- Please see the [Documentation](https://gogs.io/docs/intro) for common usages and change log.
|
|
|
+- Please visit [our home page](https://gogs.io) for user documentation.
|
|
|
+- Please refer to [CHANGELOG.md](CHANGELOG.md) for list of changes in each releases.
|
|
|
- Want to try it before doing anything else? Do it [online](https://try.gogs.io/gogs/gogs)!
|
|
|
-- Having trouble? Get help with [Troubleshooting](https://gogs.io/docs/intro/troubleshooting.html) or [User Forum](https://discuss.gogs.io/).
|
|
|
-- Want to help with localization? Check out the [guide](https://gogs.io/docs/features/i18n.html)!
|
|
|
+- Having trouble? Help yourself with [troubleshooting](https://gogs.io/docs/intro/troubleshooting.html) or ask questions on [user forum](https://discuss.gogs.io/).
|
|
|
+- Want to help with localization? Check out the [localization documentation](https://gogs.io/docs/features/i18n.html).
|
|
|
|
|
|
## Features
|
|
|
|
|
|
@@ -46,13 +46,13 @@ The Gogs (`/gɑgz/`) project aims to build a simple, stable and extensible self-
|
|
|
- Rich database backend, including PostgreSQL, MySQL, SQLite3, MSSQL and [TiDB](https://github.com/pingcap/tidb).
|
|
|
- Have localization over [30 languages](https://crowdin.com/project/gogs).
|
|
|
|
|
|
-## Hardware Requirements
|
|
|
+## Hardware requirements
|
|
|
|
|
|
- A Raspberry Pi or $5 Digital Ocean Droplet is more than enough to get you started. Some even use 64MB RAM Docker [CaaS](https://blog.docker.com/2016/02/containers-as-a-service-caas/).
|
|
|
- 2 CPU cores and 512MB RAM would be the baseline for teamwork.
|
|
|
- Increase CPU cores when your team size gets significantly larger, memory footprint remains low.
|
|
|
|
|
|
-## Browser Support
|
|
|
+## Browser support
|
|
|
|
|
|
- Please see [Semantic UI](https://github.com/Semantic-Org/Semantic-UI#browser-support) for specific versions of supported browsers.
|
|
|
- The smallest resolution officially supported is **1024*768**, however the UI may still look right in smaller resolutions, but no promises or fixes.
|
|
|
@@ -70,6 +70,17 @@ There are 6 ways to install Gogs:
|
|
|
- [Install with Vagrant](https://github.com/geerlingguy/ansible-vagrant-examples/tree/master/gogs)
|
|
|
- [Install with Kubernetes Using Helm Charts](https://github.com/helm/charts/tree/master/incubator/gogs)
|
|
|
|
|
|
+### Deploy to cloud
|
|
|
+
|
|
|
+- [OpenShift](https://github.com/tkisme/gogs-openshift)
|
|
|
+- [Cloudron](https://cloudron.io/appstore.html#io.gogs.cloudronapp)
|
|
|
+- [Scaleway](https://www.scaleway.com/imagehub/gogs/)
|
|
|
+- [Sandstorm](https://github.com/cem/gogs-sandstorm)
|
|
|
+- [sloppy.io](https://github.com/sloppyio/quickstarters/tree/master/gogs)
|
|
|
+- [YunoHost](https://github.com/YunoHost-Apps/gogs_ynh)
|
|
|
+- [DPlatform](https://github.com/j8r/DPlatform)
|
|
|
+- [LunaNode](https://github.com/LunaNode/launchgogs)
|
|
|
+
|
|
|
### Tutorials
|
|
|
|
|
|
- [How To Set Up Gogs on Ubuntu 14.04](https://www.digitalocean.com/community/tutorials/how-to-set-up-gogs-on-ubuntu-14-04)
|
|
|
@@ -79,39 +90,18 @@ There are 6 ways to install Gogs:
|
|
|
- [使用 Gogs 搭建自己的 Git 服务器](https://blog.mynook.info/post/host-your-own-git-server-using-gogs/) (Chinese)
|
|
|
- [阿里云上 Ubuntu 14.04 64 位安装 Gogs](http://my.oschina.net/luyao/blog/375654) (Chinese)
|
|
|
- [Installing Gogs on FreeBSD](https://www.codejam.info/2015/03/installing-gogs-on-freebsd.html)
|
|
|
-- [Gogs on Raspberry Pi](http://blog.meinside.pe.kr/Gogs-on-Raspberry-Pi/)
|
|
|
- [Cloudflare Full SSL with Gogs using NGINX](http://www.listekconsulting.com/articles/cloudflare-full-ssl-with-gogs-go-git-service-using-nginx/)
|
|
|
-
|
|
|
-### Screencasts
|
|
|
-
|
|
|
- [How to install Gogs on a Linux Server (DigitalOcean)](https://www.youtube.com/watch?v=deSfX0gqefE)
|
|
|
-- [Instalando Gogs no Ubuntu](https://www.youtube.com/watch?v=4UkHAR1F7ZA) (Português)
|
|
|
|
|
|
-### Deploy to Cloud
|
|
|
+## Software, service and product support
|
|
|
|
|
|
-- [OpenShift](https://github.com/tkisme/gogs-openshift)
|
|
|
-- [Cloudron](https://cloudron.io/appstore.html#io.gogs.cloudronapp)
|
|
|
-- [Scaleway](https://www.scaleway.com/imagehub/gogs/)
|
|
|
-- [Sandstorm](https://github.com/cem/gogs-sandstorm)
|
|
|
-- [sloppy.io](https://github.com/sloppyio/quickstarters/tree/master/gogs)
|
|
|
-- [YunoHost](https://github.com/YunoHost-Apps/gogs_ynh)
|
|
|
-- [DPlatform](https://github.com/j8r/DPlatform)
|
|
|
-- [LunaNode](https://github.com/LunaNode/launchgogs)
|
|
|
-
|
|
|
-## Software and Service Support
|
|
|
-
|
|
|
-- [Drone](https://github.com/drone/drone) (CI)
|
|
|
-- [Jenkins](https://wiki.jenkins-ci.org/display/JENKINS/Gogs+Webhook+Plugin) (CI)
|
|
|
- [Fabric8](http://fabric8.io/) (DevOps)
|
|
|
+- [Jenkins](https://plugins.jenkins.io/gogs-webhook/) (CI)
|
|
|
- [Taiga](https://taiga.io/) (Project Management)
|
|
|
-- [Puppet](https://forge.puppetlabs.com/Siteminds/gogs) (IT)
|
|
|
-- [Kanboard](http://kanboard.net/plugin/gogs-webhook) (Project Management)
|
|
|
+- [Puppet](https://forge.puppet.com/Siteminds/gogs) (IT)
|
|
|
+- [Kanboard](https://github.com/kanboard/plugin-gogs-webhook) (Project Management)
|
|
|
- [BearyChat](https://bearychat.com/) (Team Communication)
|
|
|
-- [HiWork](http://www.hiwork.cc/) (Team Communication)
|
|
|
- [GitPitch](https://gitpitch.com/) (Markdown Presentations)
|
|
|
-
|
|
|
-### Product Support
|
|
|
-
|
|
|
- [Synology](https://www.synology.com) (Docker)
|
|
|
- [Syncloud](https://syncloud.org/) (App Store)
|
|
|
|
ᴜɴᴋɴᴡᴏɴ