Spaces:
Runtime error
Runtime error
Nico Jensch
commited on
Commit
β’
bf0a22c
1
Parent(s):
47bbbcd
docs: apply suggestion and move information next to Archlinux, provide working example
Browse files- docs/installation.md +34 -37
docs/installation.md
CHANGED
@@ -19,6 +19,40 @@ Once you have started the server, open your preferred web browser and navigate t
|
|
19 |
|
20 |
If you want to change the port or the ip or any other configuration setting checkout the [configuration docs](./configuration.md).
|
21 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
22 |
## Other Distros
|
23 |
|
24 |
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
|
|
162 |
git checkout stable
|
163 |
```
|
164 |
|
165 |
-
## NixOS
|
166 |
-
|
167 |
-
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`.
|
168 |
-
|
169 |
-
The flake has several outputs, which may be consumed:
|
170 |
-
|
171 |
-
~~~bash
|
172 |
-
nix build .#websurfx
|
173 |
-
nix run .#websurfx
|
174 |
-
~~~
|
175 |
-
|
176 |
-
You may include it in your own flake by adding this repo to its inputs and adding it to `environment.systemPackages`
|
177 |
-
|
178 |
-
~~~nix
|
179 |
-
{
|
180 |
-
description = "My configuration";
|
181 |
-
|
182 |
-
inputs = {
|
183 |
-
websurfx.url = "github:neon-mmd/websurfx";
|
184 |
-
};
|
185 |
-
|
186 |
-
outputs = { nixpkgs, ... }@inputs: {
|
187 |
-
nixosConfigurations = {
|
188 |
-
hostname = nixpkgs.lib.nixosSystem {
|
189 |
-
system = "x86_64-linux";
|
190 |
-
modules = [{
|
191 |
-
environment.systemPackages = [
|
192 |
-
inputs.websurfx.websurfx
|
193 |
-
];
|
194 |
-
}];
|
195 |
-
};
|
196 |
-
};
|
197 |
-
};
|
198 |
-
}
|
199 |
-
|
200 |
-
~~~
|
201 |
-
|
202 |
[β¬
οΈ Go back to Home](./README.md)
|
|
|
19 |
|
20 |
If you want to change the port or the ip or any other configuration setting checkout the [configuration docs](./configuration.md).
|
21 |
|
22 |
+
## NixOS
|
23 |
+
|
24 |
+
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`.
|
25 |
+
|
26 |
+
The flake has several outputs, which may be consumed:
|
27 |
+
|
28 |
+
```bash
|
29 |
+
nix build .#websurfx
|
30 |
+
nix run .#websurfx
|
31 |
+
```
|
32 |
+
|
33 |
+
You may include it in your own flake by adding this repo to its inputs and adding it to `environment.systemPackages` as follows:
|
34 |
+
|
35 |
+
```nix
|
36 |
+
{
|
37 |
+
description = "My awesome configuration";
|
38 |
+
|
39 |
+
inputs = {
|
40 |
+
websurfx.url = "github:neon-mmd/websurfx";
|
41 |
+
};
|
42 |
+
|
43 |
+
outputs = { nixpkgs, ... }@inputs: {
|
44 |
+
nixosConfigurations = {
|
45 |
+
hostname = nixpkgs.lib.nixosSystem {
|
46 |
+
system = "x86_64-linux";
|
47 |
+
modules = [{
|
48 |
+
environment.systemPackages = [inputs.websurfx.packages.x86_64-linux.websurfx];
|
49 |
+
}];
|
50 |
+
};
|
51 |
+
};
|
52 |
+
};
|
53 |
+
}
|
54 |
+
```
|
55 |
+
|
56 |
## Other Distros
|
57 |
|
58 |
The package is currently not available on other Linux distros. With contribution and support it can be made available on other distros as well π.
|
|
|
196 |
git checkout stable
|
197 |
```
|
198 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
199 |
[β¬
οΈ Go back to Home](./README.md)
|