-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rename almost everything to Shabitica
I have just announced[1] this on the NixOS Discourse, so before users start to actually use this, let's rename the NixOS options and all the attributes accordingly, as well as the Hydra jobsets (we have two now, one for NixOS 18.03 and one for NixOS Unstable). This was long overdue and the repository has this name already. It probably would have been wiser to do this *prior* to the announcement, so I could do this without hurry. But well... I only evaluated the tests but didn't build them, if they fail to build it's not a big deal as we can fix this within the next few minutes and it's more important to have the now attribute names in place. [1]: https://discourse.nixos.org/t/self-hosted-habitica/735 Signed-off-by: aszlig <[email protected]>
- Loading branch information
Showing
28 changed files
with
325 additions
and
311 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -26,26 26,38 @@ making the client more mobile-friendly could be a viable alternative. | |
Getting started on NixOS | ||
------------------------ | ||
|
||
The easiest way is to just add the channel by issuing: | ||
The easiest way is to just add the channel and reference it via your NixOS | ||
configuration. | ||
|
||
Adding the channel on NixOS 18.03 | ||
````````````````````````````````` | ||
|
||
.. code-block:: sh-session | ||
# nix-channel --add https://headcounter.org/hydra/channel/custom/shabitica/nixos-18.03/shabitica | ||
# nix-channel --update shabitica | ||
Adding the channel on NixOS Unstable | ||
```````````````````````````````````` | ||
|
||
.. code-block:: sh-session | ||
# nix-channel --add https://headcounter.org/hydra/channel/custom/headcounter/habitica/habitica | ||
# nix-channel --update habitica | ||
# nix-channel --add https://headcounter.org/hydra/channel/custom/shabitica/nixos-18.03/shabitica | ||
# nix-channel --update shabitica | ||
You can add the service to your `NixOS configuration`_ (typically | ||
``/etc/nixos/configuration.nix``) by just importing ``<habitica>``, like this: | ||
``/etc/nixos/configuration.nix``) by just importing ``<shabitica>``, like this: | ||
|
||
.. code-block:: nix | ||
{ | ||
imports = [ <habitica> ]; | ||
habitica.hostName = "habitica.example.org"; | ||
habitica.adminMailAddress = "[email protected]"; | ||
habitica.senderMailAddress = "habitica@example.org"; | ||
imports = [ <shabitica> ]; | ||
shabitica.hostName = "shabitica.example.org"; | ||
shabitica.adminMailAddress = "[email protected]"; | ||
shabitica.senderMailAddress = "shabitica@example.org"; | ||
} | ||
This configures `Habitica`_ to run on ``habitica.example.org`` with an `NGINX | ||
This configures Shabitica to run on ``shabitica.example.org`` with an `NGINX | ||
reverse proxy`_. If you don't provide any options, it will run on your local | ||
machine only. | ||
|
||
|
@@ -71,5 83,5 @@ Ideas | |
.. _Nix: https://nixos.org/nix/ | ||
.. _NixOS configuration: https://nixos.org/nixos/manual/index.html#sec-configuration-file | ||
.. _NixOS: https://nixos.org/ | ||
.. _manual: https://headcounter.org/hydra/job/headcounter/habitica/manual/latest/download | ||
.. _manual: https://headcounter.org/hydra/job/shabitica/nixos-18.03/manual/latest/download | ||
.. _NGINX reverse proxy: https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.