status-im/nim-codex
2
0
Fork 0
mirror of https://github.com/status-im/nim-codex.git synced 2025-01-18 23:01:43 +00:00
Code Issues Projects Releases Wiki Activity

nix: update readme (#1064)

Browse Source 
Include the instructions for running nim-codex as a systemd service on
NixOS.

Signed-off-by: markoburcul <marko@status.im>
This commit is contained in:
Marko Burčul 2025-01-14 09:21:11 +01:00 committed by GitHub
parent 0cffa02748
commit 39e8e6e6fa
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
nix/README.md
View File

@ -32,4 +32,28 @@ nix run 'git+https://github.com/codex-storage/nim-codex?submodules=1#''
```sh
nix flake check ".?submodules=1#"
```
```
## Running Nim-Codex as a service on NixOS
Include nim-codex flake in your flake inputs:
```nix
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-24.11";
nim-codex-flake.url = "git+https://github.com/codex-storage/nim-codex?submodules=1#";
};
```
To configure the service, you can use the following example:
```nix
services.nim-codex = {
enable = true;
settings = {
data-dir = "/var/lib/codex-test";
};
};
```
The settings attribute set corresponds directly to the layout of the TOML configuration file
used by nim-codex. Each option follows the same naming convention as the CLI flags, but
with the -- prefix removed. For more details on the TOML file structure and options,
refer to the official documentation: [nim-codex configuration file](https://docs.codex.storage/learn/run#configuration-file).