mirror of
https://github.com/kevinveenbirkenbach/linux-image-manager.git
synced 2024-11-12 18:51:04 +01:00
Optimized README.md
This commit is contained in:
parent
f902e2a98f
commit
5555bcc2ec
BIN
.meta/core-system-screenshot.png
Normal file
BIN
.meta/core-system-screenshot.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 1.4 MiB |
22
README.md
22
README.md
@ -1,11 +1,27 @@
|
||||
# Core System
|
||||
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](./LICENSE.txt) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/6e66409513d7451b949afbf0373ba71f)](https://www.codacy.com/manual/KevinFrantz/core-system?utm_source=github.com&utm_medium=referral&utm_content=KevinFrantz/core-system&utm_campaign=Badge_Grade) [![Travis CI](https://travis-ci.org/KevinFrantz/core-system.svg?branch=master)](https://travis-ci.org/KevinFrantz/core-system)
|
||||
|
||||
This repository contains scripts to set up an working client system, maintain it and to save the data on an USB stick.
|
||||
It's adapted to the needs of Kevin Veen-Birkenbach aka. Frantz.
|
||||
This repository contains scripts to set up an working client system, maintain it and to save all important and configuration data on an USB stick. The data is stored encrypted with [EncFS](https://en.wikipedia.org/wiki/EncFS).
|
||||
It's adapted to the needs of Kevin Veen-Birkenbach aka. Frantz. Feel free to modularize it and to adapt it to your needs.
|
||||
|
||||
![Empty Core System Screen](./.meta/core-system-screenshot.png)
|
||||
<sub>*Core System* changes the wallpaper every day to the [Astronomy Picture of the Day](https://apod.nasa.gov/apod/). This wallpaper is from the 2019-10-07 and shows Jupiter with the shadow of his moon Io. </sub>
|
||||
|
||||
## Requirements
|
||||
This script is optimized for a [Manjaro Linux](https://manjaro.org) with [GNOME desktop](https://www.gnome.org/?).
|
||||
Specific system requirements are described in the [.travis file](./.travis).
|
||||
## System
|
||||
### User Data
|
||||
Right now the software expects that the *Core System Owner* has on all systems the same username. By executing the *import script* it automatic backups the application configuration data, ssh keys and other important data which is saved in well defined configuration files and folders.
|
||||
#### Specific Folders
|
||||
Next to this the following specific folders exist:
|
||||
##### $HOME/Documents/certificates/
|
||||
Contains certificates to authenticate via [certificate based authentication](https://blog.couchbase.com/x-509-certificate-based-authentication/).
|
||||
##### $HOME/Documents/recovery_codes/
|
||||
Contains files with recovery_codes e.g. for [Two-factor authentication](https://en.wikipedia.org/wiki/Multi-factor_authentication).
|
||||
##### $HOME/Documents/identity/
|
||||
Contains files to prove the identity of the *Core System Owner* in physical live like passports.
|
||||
##### $HOME/Documents/passwords/
|
||||
Contains e.g the [KeePassXC](https://keepassxc.org/) database with all *Core System Owner* passwords.
|
||||
|
||||
## Functions
|
||||
### System Setup
|
||||
|
Loading…
Reference in New Issue
Block a user