Add documentation for installation hardening and operations guide (Fix #140)
This commit is contained in:
@@ -153,3 +153,5 @@ infrastructure:
|
||||
|
||||
- [Enable extra features](features/)
|
||||
- [Use your own Identity stores](stores/README.md)
|
||||
- [Hardening your mxisd installation](install/security.md)
|
||||
- [Learn about day-to-day operations](operations.md)
|
||||
|
30
docs/install/security.md
Normal file
30
docs/install/security.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Security hardening
|
||||
## Overview
|
||||
This document outlines the various operations you may want to perform to increase the security of your installation and
|
||||
avoid leak of credentials/key pairs
|
||||
|
||||
## Configuration
|
||||
Your config file should have the following ownership:
|
||||
- Dedicated user for mxisd, used to run the software
|
||||
- Dedicated group for mxisd, used by other applications to access and read configuration files
|
||||
|
||||
Your config file should have the following access:
|
||||
- Read and write for the mxisd user
|
||||
- Read for the mxisd group
|
||||
- Nothing for others
|
||||
|
||||
This translates into `640` and be applied with `chmod 640 /path/to/config/file.yaml`.
|
||||
|
||||
## Data
|
||||
The only sensible place is the key store where mxisd's signing keys are stored. You should therefore limit access to only
|
||||
the mxisd user, and deny access to anything else.
|
||||
|
||||
Your key store should have the following access:
|
||||
- Read and write for the mxisd user
|
||||
- Nothing for the mxisd group
|
||||
- Nothing for others
|
||||
|
||||
The identity store can either be a file or a directory, depending on your version. v1.4 and higher are using a directory,
|
||||
everything before is using a file.
|
||||
- If your version is directory-based, you will want to apply chmod `700` on it.
|
||||
- If your version is file-based, you will want to apply chmod `600` on it.
|
14
docs/operations.md
Normal file
14
docs/operations.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# Operations Guide
|
||||
## Overview
|
||||
This document gives various information for the day-to-day management and operations of mxisd.
|
||||
|
||||
## Backup
|
||||
### Run
|
||||
mxisd requires all file in its configuration and data directory to be backed up.
|
||||
They are usually located at:
|
||||
- `/etc/mxisd`
|
||||
- `/var/lib/mxisd`
|
||||
|
||||
### Restore
|
||||
Reinstall mxisd, restore the two folders above in the appropriate location (depending on your install method) and you
|
||||
will be good to go. Simply start mxisd to restore functionality.
|
Reference in New Issue
Block a user