docs: promote Nixpkgs as an official installation method (#2775)
Signed-off-by: Ludovic Ortega <ludovic.ortega@adminafk.fr>
This commit is contained in:
Ludovic Ortega
96
docs/getting-started/nixpkg.mdx
Normal file
96
docs/getting-started/nixpkg.mdx
Normal file
@@ -0,0 +1,96 @@
|
||||
---
|
||||
title: Nix Package Manager (Advanced)
|
||||
description: Install Seerr using Nixpkgs
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
import { SeerrVersion, NixpkgVersion } from '@site/src/components/SeerrVersion';
|
||||
import Admonition from '@theme/Admonition';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Nix Package Manager
|
||||
:::warning
|
||||
This method is not recommended for most users. It is intended for advanced users who are using NixOS distribution.
|
||||
:::
|
||||
|
||||
:::danger
|
||||
The seerr service and package are available in the unstable channel only and will be officially included in the 26.05 release.
|
||||
:::
|
||||
|
||||
Refer to [NixOS documentation](https://search.nixos.org/options?channel=unstable&query=seerr)
|
||||
|
||||
<!--
|
||||
export const VersionMismatchWarning = () => {
|
||||
let seerrVersion = null;
|
||||
let nixpkgVersions = null;
|
||||
try {
|
||||
seerrVersion = SeerrVersion();
|
||||
nixpkgVersions = NixpkgVersion();
|
||||
} catch (err) {
|
||||
return (
|
||||
<Admonition type="error">
|
||||
Failed to load version information. Error: {err.message || JSON.stringify(err)}
|
||||
</Admonition>
|
||||
);
|
||||
}
|
||||
if (!nixpkgVersions || nixpkgVersions.error) {
|
||||
return (
|
||||
<Admonition type="error">
|
||||
Failed to fetch Nixpkg versions: {nixpkgVersions?.error || 'Unknown error'}
|
||||
</Admonition>
|
||||
);
|
||||
}
|
||||
const isUnstableUpToDate = seerrVersion === nixpkgVersions.unstable;
|
||||
const isStableUpToDate = seerrVersion === nixpkgVersions.stable;
|
||||
return (
|
||||
<>
|
||||
{!isStableUpToDate ? (
|
||||
<Admonition type="warning">
|
||||
The{' '}
|
||||
<a href="https://github.com/NixOS/nixpkgs/blob/nixos-26.05/pkgs/by-name/se/seerr/package.nix#L23">
|
||||
upstream Seerr Nix Stable Package (v{nixpkgVersions.stable})
|
||||
</a>{' '}
|
||||
is not <b>up-to-date</b>. If you want to use <b>Seerr v{seerrVersion}</b>,{' '}
|
||||
{isUnstableUpToDate ? (
|
||||
<>
|
||||
consider using the{' '}
|
||||
<a href="https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/by-name/se/seerr/package.nix">
|
||||
unstable package
|
||||
</a>{' '}
|
||||
instead.
|
||||
</>
|
||||
) : (
|
||||
<>
|
||||
you will need to{' '} override the package derivation.
|
||||
</>
|
||||
)}
|
||||
</Admonition>
|
||||
) : null}
|
||||
</>
|
||||
);
|
||||
};
|
||||
|
||||
<VersionMismatchWarning />
|
||||
-->
|
||||
|
||||
## Installation
|
||||
To get up and running with seerr using Nix, you can add the following to your `configuration.nix`:
|
||||
```nix
|
||||
{ config, pkgs, ... }:
|
||||
{
|
||||
services.seerr.enable = true;
|
||||
}
|
||||
```
|
||||
|
||||
After adding the configuration to your `configuration.nix`, you can run the following command to install seerr:
|
||||
```bash
|
||||
nixos-rebuild switch
|
||||
```
|
||||
After rebuild is complete seerr should be running, verify that it is with the following command.
|
||||
```bash
|
||||
systemctl status seerr
|
||||
```
|
||||
:::info
|
||||
You can now access Seerr by visiting `http://localhost:5055` in your web browser.
|
||||
:::
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: AUR (Advanced)
|
||||
description: Install Seerr using the Arch User Repository
|
||||
sidebar_position: 2
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# AUR
|
||||
|
||||
@@ -1,30 +0,0 @@
|
||||
---
|
||||
title: Nix Package Manager (Advanced)
|
||||
description: Install Seerr using Nixpkgs
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
import { SeerrVersion, NixpkgVersion } from '@site/src/components/SeerrVersion';
|
||||
import Admonition from '@theme/Admonition';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Nix Package Manager
|
||||
:::danger
|
||||
This method has not yet been updated for Seerr and is currently a work in progress.
|
||||
You can follow the ongoing work on these pull requests:
|
||||
- https://github.com/NixOS/nixpkgs/pull/450096
|
||||
- https://github.com/NixOS/nixpkgs/pull/450093
|
||||
:::
|
||||
|
||||
<!--
|
||||
:::warning
|
||||
Third-party installation methods are maintained by the community. The Seerr team is not responsible for these packages.
|
||||
:::
|
||||
|
||||
:::warning
|
||||
This method is not recommended for most users. It is intended for advanced users who are using NixOS distribution.
|
||||
:::
|
||||
|
||||
Refer to [NixOS documentation](https://search.nixos.org/options?channel=25.05&query=seerr)
|
||||
-->
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Synology (Advanced)
|
||||
description: Install Seerr on Synology NAS using SynoCommunity
|
||||
sidebar_position: 5
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# Synology
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: TrueNAS (Advanced)
|
||||
description: Install Seerr using TrueNAS
|
||||
sidebar_position: 4
|
||||
sidebar_position: 3
|
||||
---
|
||||
# TrueNAS
|
||||
:::warning
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Unraid (Advanced)
|
||||
description: Install Seerr using Unraid
|
||||
sidebar_position: 3
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
||||
@@ -216,16 +216,18 @@ Summary of changes :
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Nix
|
||||
|
||||
Refer to [Seerr Documentation](/getting-started/nixpkg), all of our examples have been updated to reflect the below change.
|
||||
|
||||
The seerr service and package are available in the unstable channel and will be officially included in the 26.05 release.
|
||||
|
||||
## Third-party installation methods
|
||||
|
||||
:::warning
|
||||
Third-party installation methods are maintained by the community. The Seerr team is not responsible for these packages.
|
||||
:::
|
||||
|
||||
### Nix
|
||||
|
||||
Waiting for https://github.com/NixOS/nixpkgs/pull/450096 and https://github.com/NixOS/nixpkgs/pull/450093
|
||||
|
||||
### AUR
|
||||
|
||||
See https://aur.archlinux.org/packages/seerr
|
||||
|
||||
@@ -34,9 +34,9 @@ export const NixpkgVersion = () => {
|
||||
const fetchVersion = async () => {
|
||||
try {
|
||||
const unstableUrl =
|
||||
'https://raw.githubusercontent.com/NixOS/nixpkgs/refs/heads/nixos-unstable/pkgs/by-name/je/jellyseerr/package.nix';
|
||||
'https://raw.githubusercontent.com/NixOS/nixpkgs/refs/heads/nixos-unstable/pkgs/by-name/se/seerr/package.nix';
|
||||
const stableUrl =
|
||||
'https://raw.githubusercontent.com/NixOS/nixpkgs/refs/heads/nixos-25.05/pkgs/by-name/je/jellyseerr/package.nix';
|
||||
'https://raw.githubusercontent.com/NixOS/nixpkgs/refs/heads/nixos-26.05/pkgs/by-name/se/seerr/package.nix';
|
||||
|
||||
const [unstableResponse, stableResponse] = await Promise.all([
|
||||
fetch(unstableUrl),
|
||||
|
||||
Reference in New Issue
Block a user