alamin/websurfx
alamin/websurfx
0
0
Fork 0
mirror of https://github.com/neon-mmd/websurfx.git synced 2024-11-21 21:48:21 -05:00
Code Issues Releases Activity

docs: apply suggestion and move information next to Archlinux, provide working example

Browse Source
This commit is contained in:
Nico Jensch 2023-09-27 14:22:55 +02:00
parent 47bbbcd3c4
commit bf0a22ccde
No known key found for this signature in database
GPG Key ID: CB0F39958FA44FA8
1 changed files with 34 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
docs/installation.md
View File

@ -19,6 +19,40 @@ Once you have started the server, open your preferred web browser and navigate t
If you want to change the port or the ip or any other configuration setting checkout the [configuration docs](./configuration.md). If you want to change the port or the ip or any other configuration setting checkout the [configuration docs](./configuration.md).
## NixOS
A `flake.nix` has been provided to allow installing `websurfx` easily. It utilizes [nearsk](https://github.com/nix-community/naersk) to automatically generate a derivation based on `Cargo.toml` and `Cargo.lock`.
The flake has several outputs, which may be consumed:
```bash
nix build .#websurfx
nix run .#websurfx
```
You may include it in your own flake by adding this repo to its inputs and adding it to `environment.systemPackages` as follows:
```nix
{
description = "My awesome configuration";
inputs = {
websurfx.url = "github:neon-mmd/websurfx";
};
outputs = { nixpkgs, ... }@inputs: {
nixosConfigurations = {
hostname = nixpkgs.lib.nixosSystem {
system = "x86_64-linux";
modules = [{
environment.systemPackages = [inputs.websurfx.packages.x86_64-linux.websurfx];
}];
};
};
};
}
```
## Other Distros ## Other Distros
The package is currently not available on other Linux distros. With contribution and support it can be made available on other distros as well 🙂. The package is currently not available on other Linux distros. With contribution and support it can be made available on other distros as well 🙂.
@ -162,41 +196,4 @@ cd websurfx
git checkout stable git checkout stable
``` ```
## NixOS
A flake.nix has been provided to allow installing `Websurfx` easily. It utilizes [nearsk](https://github.com/nix-community/naersk) to automatically generate a derivation based on `Cargo.toml` and `Cargo.lock`.
The flake has several outputs, which may be consumed:
~~~bash
nix build .#websurfx
nix run .#websurfx
~~~
You may include it in your own flake by adding this repo to its inputs and adding it to `environment.systemPackages`
~~~nix
{
description = "My configuration";
inputs = {
websurfx.url = "github:neon-mmd/websurfx";
};
outputs = { nixpkgs, ... }@inputs: {
nixosConfigurations = {
hostname = nixpkgs.lib.nixosSystem {
system = "x86_64-linux";
modules = [{
environment.systemPackages = [
inputs.websurfx.websurfx
];
}];
};
};
};
}
~~~
[⬅️ Go back to Home](./README.md) [⬅️ Go back to Home](./README.md)