From 82164be2e22ccb2aca8de9c7b1002144e5bc34d4 Mon Sep 17 00:00:00 2001 From: Matthieu Bessat Date: Fri, 2 Aug 2024 14:00:19 +0200 Subject: [PATCH] docs: cleanup README --- README.md | 104 ++++++---------------------------- ansible/README.md | 8 --- ansible/arch_packages.yaml | 14 +++-- ansible/vars.example.yaml | 6 -- ansible/vars.yaml | 2 - target/example_host/vars.yaml | 11 ++-- 6 files changed, 33 insertions(+), 112 deletions(-) delete mode 100644 ansible/README.md delete mode 100644 ansible/vars.example.yaml delete mode 100644 ansible/vars.yaml diff --git a/README.md b/README.md index ae3d42c..d631662 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,9 @@ Code name given on 2024-05-16 : "MonakhOS" Architecture: - Sway - +- Support of dots file repository - A single `venv` in dots containing all utilities and libs -## Ansible - -https://github.com/id101010/ansible-archlinux - ## Getting started with a VM (qemu) Cd in `sandbox_vms/vm1` @@ -35,15 +31,19 @@ Create snapshot to be able to quickly restart the ansible script with a clean im qemu-img create -f qcow2 -b after_ssh_init.img -F qcow2 ready_for_ansible.img - - ## Steps to install - find a new name for the device eg. blackjack -- connect to wifi -- enable ssh server to access it from the exterior -- generate ssh key -- add sshkey to forge.lefuturiste.fr +- install with `archinstall` to initialize the computer + - use the profiles defined in `archinstall_configs` +- connect to the internet +- enable an ssh server to access it from the ansible runner host +- on the host, generate a private ssh key +- add the public key on the target host +- create a target directory in `target` directory +- configure `vars.yaml`, see example vars file +- create on the host, the private ssh key that will be installed on target +- add this sshkey to your forge that host your dots file, eg. forge.lefuturiste.fr ### Generate a unprotected default ssh key @@ -74,86 +74,14 @@ Host aur.archlinux.org User aur ``` -### Clone dots - -``` -cd ~ -git clone git@forge.lefuturiste.fr:mbess/dots .dots -``` - -``` -cd ~/.dots -python3 -m venv venv - -pip install -r requirements.txt - -# create symbolic link to access dots -ln -s ~/.dots ~/dots -``` - -### install yay - -``` -git clone https://aur.archlinux.org/yay.git -cd yay -makepkg -si -``` - -### configure Zsh - -https://wiki.archlinux.org/title/Zsh - - - -### configure xremap - - sudo systemctl daemon-reload - - sudo systemctl enable --now xremap - - -### Import and configure GPG keys - -### Configure unix password manager - -using `extra/gopass` - -### Setup symbolic links to configs files - -run the script `setup_dot.sh` - -## Shell - -### Fish - -#### install fisher - -https://github.com/jorgebucaran/fisher - -use `fisher package` - -#### fzf fish - -https://github.com/PatrickF1/fzf.fish - -require fd and bat - -#### lfcd -https://github.com/gokcehan/lf/blob/master/etc/lfcd.fish - -### Zsh - -https://yewtu.be/watch?v=ud7YxC33Z3w -https://github.com/jeffreytse/zsh-vi-mode - -How to handle different profiles - ## Pacman packages defined in dots file arch_packages.yaml +categories: commons, work + ## Sway ### swayidle @@ -166,7 +94,7 @@ Ly is a TUI greeter, it will show a terminal based login prompt https://github.com/fairyglade/ly -## ansible +## Ansible ### auto run archinstall with ansible @@ -174,8 +102,8 @@ https://github.com/fairyglade/ly https://archinstall.archlinux.page/ - ## Pistes -https://github.com/kewlfft/ansible-aur +- https://github.com/id101010/ansible-archlinux +- https://github.com/kewlfft/ansible-aur diff --git a/ansible/README.md b/ansible/README.md deleted file mode 100644 index c0595b4..0000000 --- a/ansible/README.md +++ /dev/null @@ -1,8 +0,0 @@ -https://runebook.dev/fr/docs/ansible/collections/community/general/pacman_module -https://docs.ansible.com/ansible/2.8/modules/pacman_module.html -https://docs.ansible.com/ansible/latest/collections/community/general/pacman_module.html - -## External modules - -https://github.com/kewlfft/ansible-aur/tree/master - diff --git a/ansible/arch_packages.yaml b/ansible/arch_packages.yaml index 3a5845a..c03d150 100644 --- a/ansible/arch_packages.yaml +++ b/ansible/arch_packages.yaml @@ -357,10 +357,16 @@ common: mail: - thunderbird communication: - - signal-desktop - - name: fractal - desc: matrix client that seem to work in Rust - upstream: https://gitlab.gnome.org/World/fractal + _: + - signal-desktop + matrix: + - name: fractal + desc: Matrix client that seem to work in Rust + upstream: https://gitlab.gnome.org/World/fractal + - name: aur/cinny-desktop-bin + desc: Electron matrix client + issues: + - Notifications doesn't work with this package document: viewer: - zathura diff --git a/ansible/vars.example.yaml b/ansible/vars.example.yaml deleted file mode 100644 index 4f37396..0000000 --- a/ansible/vars.example.yaml +++ /dev/null @@ -1,6 +0,0 @@ -device_name: blackjack -user: mbess -device_platform: vm -profile: perso OR pro (work) -target_is_real: true (if not a vm) - diff --git a/ansible/vars.yaml b/ansible/vars.yaml deleted file mode 100644 index 6cbc968..0000000 --- a/ansible/vars.yaml +++ /dev/null @@ -1,2 +0,0 @@ -user: mbess -device_name: grayblower diff --git a/target/example_host/vars.yaml b/target/example_host/vars.yaml index 20e2e8f..324634f 100644 --- a/target/example_host/vars.yaml +++ b/target/example_host/vars.yaml @@ -1,8 +1,10 @@ -user: mbess device_name: somehost -profile: pro +device_type: laptop +# the username to install +user: mbess +# if it's a VM: false, if it's bare metal: false target_is_real: true -organization: companyA +# optionally configure openfortivpn openfortivpn_profiles: - name: companyA p: @@ -11,9 +13,10 @@ openfortivpn_profiles: username: user password: XXX trusted_cert: XXXXX +# What user config profiles to enable enabled_profiles: - name: pro +# What kind of categories to enable packages_categories: - common - proprietary_vpns -