Skip to content

Commit

Permalink
add doc setup section;
Browse files Browse the repository at this point in the history
  • Loading branch information
brainrake committed Nov 27, 2024
1 parent 1be1e0e commit efafdc9
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ nav:
- Getting Started:
- Overview: getting-started/overview.md
- Usage:
- Setup: usage/setup.md
- Configure pool: usage/configure-pool.md
- Generating keys: usage/generate-keys.md
- Deploy: usage/deploy.md
Expand Down
28 changes: 28 additions & 0 deletions docs/usage/setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## Installation

Follow [this guide](https://zero-to-nix.com/start/install) to Install nix with [flakes](https://nix.dev/concepts/flakes.html) enabled.

### Binary cache

You can optionally use this project's binary cache to skip building software and download it instead. Edit `/etc/nix/nix.conf` (or related settings in NixOS config) and merge the new values separated by spaces into the options:

```
substituters = ... https://cache.staging.mlabs.city/spo-anywhere
trusted-public-keys = ... spo-anywhere:bmI58BmXnmeuAtMKbm3qhwiJ1RALMfo6cDwncfaGa6Q=
```

## Start new project from flake

Create a new directory, enter it, and initialize a new project form the spo-anywhere flake template.

```
mkdir my-spo
cd my-spo
nix flake init --template github:mlabs-haskell/spo-anywhere
```

Check that the installation script starts:

```
nix run .#install -- -h
```

0 comments on commit efafdc9

Please sign in to comment.