Updated README.md

This commit is contained in:
Luc Bijl 2023-08-20 21:36:11 +02:00
parent e904b74836
commit d1d99b141a

View file

@ -1,86 +1,3 @@
# wiki.bijl.us
# Documentation for lnco projects
Documentation for the different projects and setups on [git.bijl.us](https://git.bijl.us).
To begin go to the [wiki](https://wiki.bijl.us)!
## Prerequisites
Install `mkdocs` through pip:
```
# xbps-install -Sy python3-devel python3-pip
$ pip install mkdocs mkdocs-material
```
This will put an executable in `~/.local/lib/python3.11/site-packages/mkdocs/__main__.py`
I would recommended creating an alias for using it. For example:
```
alias mkdocs="python ~/.local/lib/python3.11/site-packages/mkdocs/__main__.py"
```
## Building
Build the website through:
```
$ mkdocs build
```
And preview it with:
```
$ mkdocs serve
```
This will host the website locally on [http://127.0.0.1:8000/](http://127.0.0.1:8000/).
## Making changes to the site
Once you have made changes to any files you'll have to compile the website again before uploading it to git.
```
$ mkdocs build
$ git add .
$ git commit -m "<Your messages>"
$ git push
```
## To-Do for Void-Desktop
Important:
- [ ] Improving dotfiles of:
- [ ] SwayNC
- [ ] Tofi
- [ ] Wayfire decorations
- [ ] User packages
- [ ] Graphical package manager
- [ ] Firewall (ufw)
- [ ] User services (Turnstile backend)
- [ ] Default config and user groups automatically (no cloning of configs, (maybe a `.tar.gz` at root))
- [x] Automatic decryption through TPM (Clevis)
- [x] Clevis package
- [x] Booster werkende krijgen
- [ ] Hardenend kernel
- [ ] Sysctl optimisations
- [ ] Better luks encryption algoritm (faster)
- [ ] Better boot parameters
- [ ] Better partitioning (/usr, /proc etc their own partitions and also more secure root partition)
- [ ] Better polkit permisissions
- [ ] Applicatio sandboxing (bubblejail, bubblewrap, apparmor)
Less important:
- [ ] macchanger
- [ ] plymouth (for graphical boot up) (not possible with booster)
- [ ] ABRoot
Notes:
https://madaidans-insecurities.github.io/guides/linux-hardening.html#kernel
Documentation for the different projects and setups of lnco on [docs.bijl.us](https://docs.bijl.us)