|
|
@@ -1,137 +1,41 @@
|
|
|
-Gogs [](https://travis-ci.org/G-Node/gogs) [](https://ci.appveyor.com/project/Unknwon/gogs/branch/master) [](https://crowdin.com/project/gogs) [](https://sourcegraph.com/github.com/G-Node/gogs?badge) [](https://gitter.im/G-Node/gogs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
-=====================
|
|
|
+[](https://gitter.im/gnode-gin/Lobby)
|
|
|
+[](https://hub.docker.com/r/gnode/gogs/builds/)
|
|
|
+[](https://travis-ci.org/G-Node/gogs)
|
|
|
|
|
|
-
|
|
|
+# About Gin Gogs
|
|
|
|
|
|
-##### Current tip version: [`.VERSION`](templates/.VERSION) (see [Releases](https://github.com/G-Node/gogs/releases) for binary versions)
|
|
|
+gin-gogs is the web interface for the **GIN** (**G**-Node **IN**frastructure) services.
|
|
|
|
|
|
-| Web | UI | Preview |
|
|
|
-|:-------------:|:-------:|:-------:|
|
|
|
-||||
|
|
|
-||||
|
|
|
-||||
|
|
|
+## What is gin?
|
|
|
+Management of scientific data, including consistent organization, annotation and storage of data, is a challenging task. Accessing and managing data from multiple workplaces while keeping it in sync, backed up, and easily accessible from within or outside the lab is even more demanding.
|
|
|
|
|
|
-### Important Notes
|
|
|
+To minimize the time and effort scientists have to spend on these tasks, we develop the GIN (G-Node Infrastructure) services, a free data management system designed for comprehensive and reproducible management of scientific data.
|
|
|
|
|
|
-1. **YOU MUST READ [Contributing Code](https://github.com/G-Node/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 `develop` branch.
|
|
|
-4. If you think there are vulnerabilities in the project, please talk privately to **u@gogs.io**, and the name you want to be credited as. Thanks!
|
|
|
-5. If you're interested in using APIs, we have experimental support with [documentation](https://github.com/gogits/go-gogs-client/wiki).
|
|
|
-6. If your team/company is using Gogs and would like to put your logo on [our website](https://gogs.io), contact us by any means.
|
|
|
+## Why should I use gin?
|
|
|
+### Manage your data from anywhere
|
|
|
+* Upload your data on a repository based structure: you can create as many repositories as you like.
|
|
|
+* Access your data from anywhere: once the data is at the main repository service you can securely access your data from anywhere you like.
|
|
|
+* Synchronize your data: you can download complete or partial repositories on any workplace you like, work on them locally and upload the changes back to the main repository.
|
|
|
|
|
|
-[简体中文](README_ZH.md)
|
|
|
+### Version your data
|
|
|
+* When changing your files and uploading them to the server, the history is automatically kept, you can always go back to a previous version.
|
|
|
|
|
|
-## Purpose
|
|
|
|
|
|
-The goal of this project is to make 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** that Go supports, including Linux, Mac OS X, Windows and ARM.
|
|
|
+### Share your data
|
|
|
+* Make your data public: if you want to make your data accessible to the world, just make your repository publicly available. The data will be accessible but only you will be able to change it.
|
|
|
+* Share your data with collaborators: you can also share repositories with other users of the GIN service making it easy to jointly work on a project.
|
|
|
+* Make your data citable: through the gin DOI service you can obtain registered identifiers for your public datasets.
|
|
|
|
|
|
-## Overview
|
|
|
|
|
|
-- Please see the [Documentation](https://gogs.io/docs/intro) for common usages and change log.
|
|
|
-- 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)!
|
|
|
+### Choose how you want to use our service
|
|
|
+* Register with the GIN services and use the provided infrastructure.
|
|
|
+* Set up and host your own in-house instance - our software is open source, you can use it for free.
|
|
|
|
|
|
-## Features
|
|
|
-
|
|
|
-- Activity timeline
|
|
|
-- SSH and HTTP/HTTPS protocols
|
|
|
-- SMTP/LDAP/Reverse proxy authentication
|
|
|
-- Reverse proxy with sub-path
|
|
|
-- Account/Organization/Repository management
|
|
|
-- Add/Remove repository collaborators
|
|
|
-- Repository/Organization webhooks (including Slack and Discord)
|
|
|
-- Repository Git hooks/deploy keys
|
|
|
-- Repository issues, pull requests, wiki and protected branches
|
|
|
-- Migrate and mirror repository and its wiki
|
|
|
-- Web editor for repository files and wiki
|
|
|
-- Jupyter Notebook
|
|
|
-- Two-factor authentication
|
|
|
-- Gravatar and Federated avatar with custom source
|
|
|
-- Mail service
|
|
|
-- Administration panel
|
|
|
-- Supports MySQL, PostgreSQL, SQLite3, MSSQL and [TiDB](https://github.com/pingcap/tidb) (via MySQL protocol)
|
|
|
-- Multi-language support ([25 languages](https://crowdin.com/project/gogs))
|
|
|
-
|
|
|
-## 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
|
|
|
-
|
|
|
-- 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.
|
|
|
-
|
|
|
-## Installation
|
|
|
-
|
|
|
-Make sure you install the [prerequisites](https://gogs.io/docs/installation) first.
|
|
|
-
|
|
|
-There are 5 ways to install Gogs:
|
|
|
-
|
|
|
-- [Install from binary](https://gogs.io/docs/installation/install_from_binary.html)
|
|
|
-- [Install from source](https://gogs.io/docs/installation/install_from_source.html)
|
|
|
-- [Install from packages](https://gogs.io/docs/installation/install_from_packages.html)
|
|
|
-- [Ship with Docker](https://github.com/G-Node/gogs/tree/master/docker)
|
|
|
-- [Install with Vagrant](https://github.com/geerlingguy/ansible-vagrant-examples/tree/master/gogs)
|
|
|
-
|
|
|
-### 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)
|
|
|
-- [Run your own GitHub-like service with the help of Docker](http://blog.hypriot.com/post/run-your-own-github-like-service-with-docker/)
|
|
|
-- [Dockerized Gogs git server and alpine postgres in 20 minutes or less](http://garthwaite.org/docker-gogs.html)
|
|
|
-- [Host Your Own Private GitHub with Gogs](https://eladnava.com/host-your-own-private-github-with-gogs-io/)
|
|
|
-- [使用 Gogs 搭建自己的 Git 服务器](https://mynook.info/blog/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
|
|
|
-
|
|
|
-- [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)
|
|
|
-
|
|
|
-## 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)
|
|
|
-- [Taiga](https://taiga.io/) (Project Management)
|
|
|
-- [Puppet](https://forge.puppetlabs.com/Siteminds/gogs) (IT)
|
|
|
-- [Kanboard](http://kanboard.net/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)
|
|
|
-- [One Space](http://www.onespace.cc) (App Store)
|
|
|
+### Enhanced search of your repositories **in development**
|
|
|
+By indexing the repository contents it's easy to find the files you are looking for. When using the [NIX](http://www.g-node.org/nix) data format for scientific data and metadata, even the contents of these files will be indexed and searchable, making it easy for you to identify the data you are looking for.
|
|
|
|
|
|
## Acknowledgments
|
|
|
-
|
|
|
-- Thanks [Egon Elbre](https://twitter.com/egonelbre) for designing logo.
|
|
|
-- Thanks [Crowdin](https://crowdin.com/project/gogs) for providing open source translation plan.
|
|
|
-- Thanks [DigitalOcean](https://www.digitalocean.com) for hosting home and demo sites.
|
|
|
-- Thanks [KeyCDN](https://www.keycdn.com/) and [QiNiu](http://www.qiniu.com/) for providing CDN service.
|
|
|
-
|
|
|
-## Contributors
|
|
|
-
|
|
|
-- See [contributors page](https://github.com/gogits/gogs/graphs/contributors) for top 100 contributors.
|
|
|
-- See [TRANSLATORS](conf/locale/TRANSLATORS) for public list of translators.
|
|
|
+Gin Gogs is largly based on [Gogs](https://github.com/gogits/gogs)
|
|
|
|
|
|
## License
|
|
|
|
cgars