commit - d0e8cbceae1c4ebef5a7cfc46acbf0e4137f7e8e
commit + df7a70ed077a86e2e21083368fd051dd02f46aed
blob - 82361647db6cc996e63316fcd5da5cfd8965ecdd
blob + 7b700fdb9efb0492a8d24089c3c4935d2224e2bc
--- index.html
+++ index.html
</pre>
<p>
This configuration serves website content from the <b>www</b> repository
- and allows you to browse the website at <a href="/">demo.gothub.org</a>. It
- is conveniently managed by committing changes to the repository.
+ and allows browsing the website at <a href="/">demo.gothub.org</a>. It is
+ conveniently managed by committing changes to the repository.
</p>
<p>
- Since the website makes use of the root domain, we set the <b>repositories
- url path</b> to <b>/repos</b>, allowing you to still browse repositories at
+ Since the website makes use of the root domain, the <b>repositories url
+ path</b> is set to <b>/repos</b>, allowing repositories to be browsed at
<a href="/repos">demo.gothub.org/repos</a>.
</p>
<p>
- Note that we <b>disable authentication</b>, as web servers on the Game of
- Trees Hub are configured with authentication enabled by default. Without
- this, you would be required to log in to view the website.
+ Note that the <b>disable authentication</b> directive is used, as web
+ servers on the Game of Trees Hub are configured with authentication enabled
+ by default. Without this, viewing the website would require users to be
+ logged in.
</p>
<p>
- Want a different setup? See the examples below to learn more! For
+ See the examples below to learn about different configurations. For
additional documentation, see
<a href="https://gameoftrees.org/gotsys.conf.5.html">gotsys.conf(5)</a>.
</p>
<div id="repo-management" class="config">
<p>
One of <a href="https://gameoftrees.org/gotsysd.8.html">gotsysd(8)</a>'s
- coolest features is its ability to let you manage your repositories
- directly from
+ features is its ability to let users manage their repositories directly
+ from
<a href="https://gameoftrees.org/gotsys.conf.5.html">gotsys.conf(5)</a>.
- For example, your server configuration will initially contain the following
+ For example, all server configurations will initially contain the following
snippet:
</p>
<pre>
repository.
</p>
<p>
- The <em>gotsys</em> repository is special, as it lets you manage your
+ The <em>gotsys</em> repository is special, as it lets users manage their
repository space by committing changes to it. However, it is declared as
any other repository. For example, the following snippet creates three new
repositories:
}
</pre>
<p>
- Just like with the <em>gotsys</em> repository, we declare three new
- repositories that can be read and written to by the <em>flan_hacker</em>.
+ Just like with the <em>gotsys</em> repository, three new repositories are
+ declared that can be read and written to by the <em>flan_hacker</em> user.
Note that <em>public_repo_b</em> also allows the <em>anonymous</em> user to
clone the repository, but not to send new changes to it, as it is declared
with the <b>ro</b> mode (read-only). Repositories that are readable by the
repository when browsing it with a web browser.
</p>
<p>
- Lastly, it is worth noting that there is currently no way to rename or
- delete repositories via
+ It is worth noting that there is currently no way to rename or delete
+ repositories via
<a href="https://gameoftrees.org/gotsys.conf.5.html">gotsys.conf(5)</a>.
- However, you can simply remove any repository declaration from your
- configuration and the repository will no longer be accesible.
+ However, existing repositories that are no longer mentioned in the
+ configuration will be inaccessible, as if they had been declared without
+ any access rules.
</p>
</div>
</details>
<summary>Setting up a custom domain</summary>
<div id="custom-domain" class="config">
<p>
- A good way to personalize your repository space is by assigning it a custom
+ A good way to personalize a repository space is by assigning it a custom
domain. This can be done as follows:
</p>
<ol>
</li>
<li>
<p>
- Lastly, configure a <b>web server</b> in your
+ Lastly, configure a <b>web server</b> in
<a href="https://gameoftrees.org/gotsys.conf.5.html">gotsys.conf(5)</a>
- using your custom domain. For example, the following snippet configures
+ using the custom domain. For example, the following snippet configures
one for <a href="https://no.vmmbugs.net">no.vmmbugs.net</a>:
</p>
<pre>
<div id="authentication" class="config">
<p>
The Game of Trees Hub configures all web servers with authentication
- enabled by default. This requires visitors to log in before accessing your
- repositories or website. However, it is up to you to configure who is
- allowed to authenticate and who isn't. If you want anyone to be able to
- authenticate, you can use the <em>anonymous</em> user, a reserved user
- which doesn't need to be declared with the <b>user</b> directive:
+ enabled by default. This requires visitors to log in before accessing
+ repositories or a website. To allow anyone to authenticate, the
+ <em>anonymous</em> user can be used:
</p>
<pre>
web server no.vmmbugs.net {
}
</pre>
<p>
- This will present you with a login screen and instructions on how to
- authenticate over ssh when visiting
+ This will present all visitors with a login screen and instructions on how
+ to authenticate over ssh when visiting
<a href="https://no.vmmbugs.net">no.vmmbugs.net</a>.
</p>
<p>
- If you want only specific users to be able to authenticate, you need to
- declare them first with the <b>user</b> directive:
+ In order to allow only specific users to authenticate, those users must
+ first be declared with the <b>user</b> directive:
</p>
<pre>
user flan_hacker {
}
</pre>
<p>
- Note that in this case you won't be presented with instructions on how to
- authenticate, as it is expected from the permitted user to know how to do
- so.
+ Note that in this case, visitors won't be presented with instructions on
+ how to authenticate, as it is expected from the permitted user to know how
+ to do so.
</p>
<p>
- You can set <b>permit</b>/<b>deny</b> rules for all repositories on a web
- server, like we did in the examples above, or per-repository using the
- <b>repository</b> directive within the web server block.
+ The <b>permit</b> and <b>deny</b> directives can be set for all
+ repositories on a web server, like in the example above, or per-repository
+ using the <b>repository</b> directive within the web server block.
</p>
<p>
- As a nice bonus, enabling authentication gives your repositories and
- website an added layer of protection against scraping bots.
+ As a nice bonus, enabling authentication gives repositories and websites an
+ added layer of protection against scraping bots.
</p>
</div>
</details>
<summary>Configuring the visibility of repositories</summary>
<div id="repo-visibility" class="config">
<p>
- When first configuring a web server, you may notice that no repositories
- are shown in the repository index. This is because web servers on the Game
- of Trees Hub are initially configured to hide all repositories, preventing
- the accidental leakage of private repositories. You can use
- repository-specific parameters to configure this behaviour.
+ When first configuring a web server, the repository index will be empty by
+ default. This is because web servers on the Game of Trees Hub are initially
+ configured to hide all repositories, preventing the accidental leakage of
+ private repositories. This behaviour can be configured by using
+ repository-specific parameters.
</p>
<p>
Repository-specific parameters can be set by using the <b>repository</b>
}
</pre>
<p>
- If most of your repositories are public, you can spare yourself some typing
- by making all repositories visible by default, and hiding only the private
- ones.
+ Alternatively, repositories can be made visible by default and private
+ repositories can be hidden as needed.
</p>
<pre>
web server no.vmmbugs.net {
}
}
</pre>
- <p>
- If you decide to do this, be careful not to leak any private repositories!
- </p>
</div>
</details>
<details name="example">
<div id="config-check" class="config">
<p>
Invalid configurations will be automatically rejected by the server when
- sending changes to it. To avoid this, you can validate your configuration
+ sending changes to it. To avoid this, configurations can be validated
before committing any changes with the following
<a href="https://gameoftrees.org/gotsys.1.html">gotsys(1)</a>
command:
$ gotsys check -f /path/to/gotsys.conf
</pre>
<p>
- This will report any errors in your configuration. Once there are no more
- errors, the command will output <em>configuration OK</em>, at which point you
- can safely send your changes to the server.
+ This will report any errors in the configuration. Once there are no more
+ errors, the command will output <em>configuration OK</em>, at which point
+ changes can be safely sent to the server.
</p>
</div>
</details>
