Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rasmus-kirk committed Feb 24, 2024
1 parent f7b3f40 commit bc8e127
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 50 deletions.
55 changes: 7 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,10 +85,10 @@ nixarr = {
};
```

Another example where port forwarding is not an option. This could be for
example if you're living in a dorm:
Another example where port forwarding is not an option. This could be useful
for example if you're living in a dorm without access to port forwarding:

```nix{.numberLines}
```nix {.numberLines}
nixarr = {
enable = true;
Expand Down Expand Up @@ -120,49 +120,8 @@ nixarr = {
};
```

## Todo

### Documentation

Add a wiki with documentation and guides.

### DDNS

Add DDNS-support.

- [ ] Njalla

### State Directories

- [x] Jellyfin: Works
- [x] Prowlarr: Works
- [x] Sonarr: Works
- [x] Radarr: Works
- [x] Lidarr: Works
- [x] Readarr: Works
- [ ] Transmission: Works for VPN, get weird bug, if
`services.transmission.dataDir` is set.

### Buildarr

Using buildarr would allow setup services to integrate with each other upon
activation with no user input, definitely nice.

Needs to be added to nixpkgs, not too hard, but is not worth it if the
project is abandoned.

- [ ] Package with nix
- [ ] Add to nixpkgs

### DNS leaks

Prevent DNS leaks _without using containerization,_ as is currently done. No
idea how this could be done, but would simplify things _a lot_.

### cross-seed

Create support for the [cross-seed](https://github.com/cross-seed/cross-seed) service.
## VPN

- [ ] Package with nix
- [ ] Create nix service daemon
- [ ] Add to nixpkgs
It's recommended that the VPN you're using has support for port forwarding. I
suggest [AirVpn](https://airvpn.org/), since they accept Monero, but you can
use whatever you want.
3 changes: 2 additions & 1 deletion docs/pandoc/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,8 @@ footer .content {
}

.content-wrap {
padding-bottom: 2.5rem;
padding-bottom: 4rem;
overflow-wrap: break-word;
}

a {
Expand Down
4 changes: 3 additions & 1 deletion mkDocs.nix
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,9 @@ in pkgs.stdenv.mkDerivation {
# shellcheck disable=SC2016
sed '/^`[^`]*`$/s/`\(.*\)`/```nix\n\1\n```/g' "$tmpdir"/1.md > "$tmpdir"/2.md
# Remove bottom util-nixarr options
sed '/util-nixarr/,$d' "$tmpdir"/2.md > "$tmpdir"/done.md
sed '/util-nixarr/,$d' "$tmpdir"/2.md > "$tmpdir"/3.md
# Make h2 header to h3
sed 's/^##/###/g' "$tmpdir"/3.md > "$tmpdir"/done.md
pandoc \
--standalone \
Expand Down

0 comments on commit bc8e127

Please sign in to comment.