roundabout.html
HTML document, Unicode text, UTF-8 text
1<!DOCTYPE html> 2<html lang="en"> 3<head> 4<meta charset="UTF-8"> 5<title> 6The roundabout 7</title> 8<link rel="stylesheet" href="/static/style.css"> 9<meta name="viewport" content="width=device-width, initial-scale=1.0"> 10</head> 11<body> 12<header> 13<nav> 14<ul> 15<li><a href="/">Home</a></li> 16<li><a href="/projects">Projects</a></li> 17<li><a href="/index">Index</a></li> 18<li><a href="https://roundabout-host.com/roundabout">Roundabout-host</a></li> 19</ul> 20<ul> 21<li><a href="mailto:root@roundabout-host.com" id="mail-link">root@roundabout-host.com</a></li> 22</ul> 23</nav> 24</header> 25<main> 26 27<h1 class="project-title"> 28<span>The roundabout</span> 29<a href="https://roundabout-host.com/roundabout/roundabout">Repository</a> 30</h1> 31<article class="content-area"> 32<p>The roundabout is a <strong class="emphasis-2">git repository hosting</strong> server software. It is designed to be a complete 33alternative to GitHub, GitLab, BitBucket, Gogs/Gitea/Forgejo, and other similar services. It 34is still in development and not yet ready for production use. As of version 0.3.0 development 35stage, it supports: 36</p><ul><li><p>User registration 37</p></li><li><p>Repository creation 38</p></li><li><p>User access control 39</p></li><li><p>Smart Git over HTTP(S) protocol 40</p></li><li><p>Web interface for repository browsing 41</p></li><li><p>User profiles and social features 42</p></li><li><p>Forum for repositories, useful for issue tracking 43</p></li><li><p>Notifications, including email notifications 44</p></li><li><p>Pull requests 45</p></li><li><p>Favourite repositories (subscriptions) 46</p></li><li><p>Commit views and diffs 47</p></li><li><p>Themeing 48</p></li><li><p>Static site hosting 49</p></li><li><p>Really basic search 50</p></li><li><p>Markdown, but only for files (see below) 51</p></li></ul><p>For now, it doesn't support, but certainly <strong class="emphasis-2">will</strong> before the 1.0.0 release: 52</p><ul><li><p>Code review features (like comments on commits, for now you'll use the forum), something 53like Google Docs comments is planned 54</p></li><li><p>CI/CD 55</p></li><li><p>API 56</p></li><li><p>Repository metadata (licence, topics, language, etc.) 57</p></li><li><p>Decentralization 58</p></li><li><p>Packaging 59</p></li><li><p>Code syntax highlighting 60</p></li><li><p>Any kind of statistics 61</p></li><li><p>Web-based code editing 62</p></li><li><p>Users changing passwords 63</p></li><li><p>Admin panel 64</p></li><li><p>Forum labels 65</p></li><li><p>User mentions 66</p></li><li><p>Markdown comments (we just need to cache the HTML so it won't be too slow) 67</p></li></ul><p>It won't support: 68</p><ul><li><p>Wikis (why have another interface just for markdown, when you can use your own repo and publish 69it as a static site?) 70</p></li><li><p>Issues (forum does it already) 71</p></li></ul><p>I'm still not sure about: 72</p><ul><li><p>Project boards (what about making label grouping instead?) 73</p></li><li><p>Advertising (don't worry, instances could disable it, and logged-in users could also disable it 74for free, and it won't track anyone, no video, animation, sound, popups, overlays, or JS) 75</p></li><li><p>Paste service (does it really work well with Git? Couldn't you just use a repo for that?) 76</p></li><li><p>Git over SSH or other protocols (do people need it? HTTPS does the same things, and it's easier 77to set up; doesn't require daemons) 78</p></li><li><p>Native clients (Android development is hard, iOS is hostile, and on desktop it's not needed, 79there are GUI git clients that work with any server, for social features web is fine) 80</p></li><li><p>IDE plugins (sounds good, but it's hard work) 81</p></li></ul><p>The roundabout is written in flask, a Python web framework. It uses SQLAlchemy for database 82management. For light UI interactivity it uses htmx and some vanilla JS. It does some GitPython 83calls for basic operations, but mostly calls git with subprocess. Repositories are non-bare 84because this allows the server to understand the repository and can lead to some performance 85gains since querying git is not required. The server is designed to be run on a single machine 86but decentralisation will be added in the future, but it won't be automatic, you'll have to 87choose a server to use. 88</p><h2>roundabout-host.com</h2><p>The official instance of the roundabout, roundabout-host, is hosted at 89<a href="https://roundabout-host.com">roundabout-host.com</a>. Anyone can register and create repositories 90there. However, we ask that you do not rely on it and always keep your repos locally as well. 91Uptime is not guaranteed, and data loss is possible. The server is not backed up. 92</p><p>In the future it may require payment for some features, but <strong class="emphasis-2">the program it runs will always 93be free</strong>. Payment will not be required to lift artificial limitations, but to support 94server-intensive features like CI/CD. Some free usage for useful projects will always be 95provided on demand. 96</p><p>Additionally, we may have advertising on the site. It will be unobtrusive and not track you. 97Logged-in users will be able to disable it for free. We will never have video, animation, sound, 98popups, overlays, or JS ads. Ads will be relevant to the content of the site, but they won't 99be personalised or use cookies. This just means no car, insurance, supermarket, or other 100unrelated ads. Most likely we will use EthicalAds, which is itself free software. 101</p><p>The roundabout program is licensed under the AGPL licence, version 3.0 or, at your option, any 102later version. Whatever I decide to do for roundabout-host, I can't pull the rug from under 103you, you can always run your own instance. 104</p> 105</article> 106 107</main> 108<footer> 109<p>Page generated on Tuesday, 21 May 2024 at 17:53:32</p> 110<p xmlns:cc="http://creativecommons.org/ns#" >This work is marked with <a href="https://creativecommons.org/publicdomain/zero/1.0/?ref=chooser-v1" target="_blank" rel="license noopener noreferrer" style="display:inline-block;">CC0 1.0 Universal</a> (🄍). No rights reserved.</p> 111<a href="#">Back to top</a> 112</footer> 113</body> 114</html>