mirror of
https://git.oat.zone/dark-firepit/dotfiles
synced 2024-11-22 17:01:57 +01:00
update readme
This commit is contained in:
parent
b8bb13f19a
commit
dc5b534a36
16
README.md
16
README.md
@ -1,23 +1,23 @@
|
|||||||
# Frosted Flakes
|
# Frosted Flakes
|
||||||
|
|
||||||
Nix Flake dotfiles shared across a [few hosts](./hosts/). Most development here will go into the [`dark-firepit`](https://dark-firepit.cloud/) host, however.
|
Nix Flake dotfiles shared across a [few hosts](./hosts/). Most development here will go into the [`lucent-firepit`](https://dark-firepit.cloud/) host, however.
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
_Commands here will use `dark-firepit`-based paths and names as an example_
|
_Commands here will use `lucent-firepit`-based paths and names as an example_
|
||||||
|
|
||||||
- To build the system (doesn't apply changes):
|
- To build the system (doesn't apply changes):
|
||||||
```sh
|
```sh
|
||||||
nixos-rebuild build --upgrade --impure --flake /etc/dotfiles#dark-firepit
|
nixos-rebuild build --upgrade --impure --flake /etc/dotfiles#lucent-firepit
|
||||||
```
|
```
|
||||||
- To build & switch to a new system (applies changes):
|
- To build & switch to a new system (applies changes):
|
||||||
```sh
|
```sh
|
||||||
doas nixos-rebuild switch --impure --upgrade --flake /etc/dotfiles#dark-firepit
|
doas nixos-rebuild switch --impure --upgrade --flake /etc/dotfiles#lucent-firepit
|
||||||
```
|
```
|
||||||
|
|
||||||
### `dark-firepit`
|
### `lucent-firepit`
|
||||||
|
|
||||||
Things here mostly only apply to the [`dark-firepit`](https://dark-firepit.cloud/) host.
|
Things here mostly only apply to the [`lucent-firepit`](https://dark-firepit.cloud/) host.
|
||||||
|
|
||||||
#### Adding modules
|
#### Adding modules
|
||||||
|
|
||||||
@ -26,7 +26,7 @@ Generally when adding modules (even those pulled from `nixpkgs`) you'd want to:
|
|||||||
1. Create a new module under `modules/services/`; `gitea.nix` and `nitter.nix` are pretty okay examples of what to do
|
1. Create a new module under `modules/services/`; `gitea.nix` and `nitter.nix` are pretty okay examples of what to do
|
||||||
2. **`git add .`** or else Nix will act clueless about everything you've just done
|
2. **`git add .`** or else Nix will act clueless about everything you've just done
|
||||||
3. Set it to enabled, set port, domain, etc. in `hosts/.../default.nix` or wherever else is more appropriate
|
3. Set it to enabled, set port, domain, etc. in `hosts/.../default.nix` or wherever else is more appropriate
|
||||||
- For webapps, follow what's done in `hosts/dark-firepit/webapps/default.nix`; if you're doing something bigger, it may be worth abstracting into a seperate file
|
- For webapps, follow what's done in `hosts/lucent-firepit/webapps/default.nix`; if you're doing something bigger, it may be worth abstracting into a seperate file
|
||||||
4. Rebuild/switch to the new system (as described [above](#development))
|
4. Rebuild/switch to the new system (as described [above](#development))
|
||||||
|
|
||||||
#### `yugoslavia-best.nix`
|
#### `yugoslavia-best.nix`
|
||||||
@ -43,4 +43,4 @@ This can be done directly on the server (as long as you have the `dotfiles` grou
|
|||||||
|
|
||||||
If you encounter permission funnies, don't hesitate to `doas` your way into `chmod`dding/`chown`ing files as necessary; directories should be `775` and files should be `664`, however we've yet to figure out how to consistently enforce this across the directory.
|
If you encounter permission funnies, don't hesitate to `doas` your way into `chmod`dding/`chown`ing files as necessary; directories should be `775` and files should be `664`, however we've yet to figure out how to consistently enforce this across the directory.
|
||||||
|
|
||||||
Be sure to commit regularly to prevent [tons of](https://git.oat.zone/dark-firepit/dotfiles/commit/021fab40f7f815708d4cf918ec0ac0bd16c0bc8f) [densely packed](https://git.oat.zone/dark-firepit/dotfiles/commit/07f9ac6a9ee53f6689a5f8ee87b94b96a409c375) [undocumented commits](https://git.oat.zone/dark-firepit/dotfiles/commit/9da0a143ae392ec7f8abc731e8c245f29b55e685) building up after noone bothers to commit anything.
|
Be sure to commit regularly to prevent [tons of](https://git.oat.zone/dark-firepit/dotfiles/commit/021fab40f7f815708d4cf918ec0ac0bd16c0bc8f) [densely packed](https://git.oat.zone/dark-firepit/dotfiles/commit/07f9ac6a9ee53f6689a5f8ee87b94b96a409c375) [undocumented commits](https://git.oat.zone/dark-firepit/dotfiles/commit/9da0a143ae392ec7f8abc731e8c245f29b55e685) building up after noone bothers to commit anything.
|
||||||
|
Loading…
Reference in New Issue
Block a user