README.md
ASCII text
Roundabout
Roundabout is a simple git hosting server that does a few things:
It allows you to push and pull git repositories, currently only over HTTP(S).
Why HTTP? It's easy to set up, can be more easily integrated, supports encryption (HTTPS) while still allowing anonymous cloning, and is easier for this to implement: SSH would require integration with the git daemon.
It has a web interface, without any SPA nonsense. JS is used to enhance the experience, not to replicate everything your browser natively does.
You can have an account and manage your repositories.
You can collaborate with others using forums and code reviews on commits.
You can merge, of course.
There are email notifications for various events.
There are no wikis, but there is static site hosting.
Experimental support for federated merging from other roundabouts.
It doesn't try to replace your local copy. It doesn't have web editing or features which don't benefit from collaboration, in other words, it's not a SaaSS (Service as a Software Substitute).
It's not yet stable, and you should always keep local repositories (this is true for any git hosting service).
It's written in Python and uses the Flask web framework, the SQLAlchemy ORM, and the Jinja2 templating engine. It uses the git command line tool for git access.
Most importantly, it's free software, licensed under the GNU Affero General Public Licence, version 3 or later; see the licence file for more information.
There's an official roundabout, here at https://roundabout-host.com.
I call instances roundabouts, as a common noun. roundabout-host is just the official one, don't use that name to refer to the software itself.
It was named roundabout because it's a node for branches. For the Americans, roundabout means traffic circle.
Please report bugs and leave suggestions on the forum.
1Roundabout 2========== 3 4Roundabout is a simple git hosting server that does a few things: 5 6* It allows you to push and pull git repositories, currently only over HTTP(S). 7* Why HTTP? It's easy to set up, can be more easily integrated, supports 8encryption (HTTPS) while still allowing anonymous cloning, and is 9easier for this to implement: SSH would require integration with the git 10daemon. 11* It has a web interface, without any SPA nonsense. JS is used to enhance the 12experience, not to replicate everything your browser natively does. 13* You can have an account and manage your repositories. 14* You can collaborate with others using forums and code reviews on commits. 15* You can merge, of course. 16* There are email notifications for various events. 17* There are no wikis, but there is static site hosting. 18* Experimental support for federated merging from other roundabouts. 19 20It doesn't try to replace your local copy. It doesn't have web editing or 21features which don't benefit from collaboration, in other words, it's not a 22SaaSS (Service as a Software Substitute). 23 24It's not yet stable, and you should always keep local repositories (this is 25true for any git hosting service). 26 27It's written in Python and uses the Flask web framework, the SQLAlchemy ORM, and 28the Jinja2 templating engine. It uses the git command line tool for git access. 29 30Most importantly, it's free software, licensed under the GNU Affero General 31Public Licence, version 3 or later; see [the licence file](LICENCE.md) for more 32information. 33 34There's an official roundabout, here at <https://roundabout-host.com>. 35 36I call instances roundabouts, as a common noun. roundabout-host is just the 37official one, don't use that name to refer to the software itself. 38 39It was named roundabout because it's a node for branches. For the Americans, 40roundabout means traffic circle. 41 42Please report bugs and leave suggestions on the 43[forum](https://roundabout-host.com/roundabout/roundabout/forum). 44