zamba-lxc-toolbox/README.md

# Zamba

## About
Zamba is a Toolbox for Proxmox admins, which fires up a container and installs a service (listed below) on it.
### Requirements
Proxmox VE Server with at least one configured ZFS Pool.
### Included services:
- Debian LXC Container
- ZMB (Samba) standalone with ZFS volume snapshot support
- ZMB (Samba) AD member with ZFS volume snapshot support
- ZMB (Samba) Active Directory Domain Controller
- mailpiler mail archive [mailpiler.org](https://www.mailpiler.org/)
- Matrix Synapse Homeserver [matrix.org](https://matrix.org/docs/projects/server/synapse) with Element Web [Element on github](https://github.com/vector-im/element-web)
### Planned features / ideas for future releases
- Nextcloud Server [nextcloud.com](https://nextcloud.com/)
- check_mk RAW Edition [checkmk.com](https://checkmk.com)
- Zabbix [zabbix.com](https://zabbix.com)
- Abgleich control machine (ZFS Snapshot and Backup engine) [Abgleich on github](https://github.com/pleiszenburg/abgleich)
- Jitsi Meet server [jitsi.org](https://jitsi.org/jitsi-meet/)
- Kopano One [kopano.com](https://kopano.com/)
## Usage
Just ssh into your Proxmox machine and clone this git repository. Make sure you have installed `git`.
### Clone this Repository
```bash
apt update
apt -y install git
git clone https://git.spille-edv.de/thorsten.spille/zamba
cd zamba
```
### Configuration
To fit your requirements, please edit the file `zamba.conf` with your favourite test editor (e.g. `vim` or `nano`).
The required adjustments are in the LXC container section and in the section for the service you want to launch.
For further information about the config variables, have a look at [zamba.conf.md](zamba.conf.md)
### Installation
After configuring, you are able to launch the script interactively:
```bash
bash install.sh
```
After container creation, you will be prompted to select the service to install and depending on the service there may be some more questions during installation.

Once the script has finished, the container is installed and running and you can continue with the service specific configuration.
First version of README.md 2021-04-08 23:13:20 +02:00			`# Zamba`

			`## About`
Corrected README.md 2021-04-09 20:31:22 +02:00			`Zamba is a Toolbox for Proxmox admins, which fires up a container and installs a service (listed below) on it.`
			`### Requirements`
			`Proxmox VE Server with at least one configured ZFS Pool.`
			`### Included services:`
Moved AD DC to includes services 2021-04-12 23:49:34 +02:00			`- Debian LXC Container`
Added zmb standalone to included services 2021-04-14 01:03:21 +02:00			`- ZMB (Samba) standalone with ZFS volume snapshot support`
First version of README.md 2021-04-08 23:13:20 +02:00			`- ZMB (Samba) AD member with ZFS volume snapshot support`
Moved AD DC to includes services 2021-04-12 23:49:34 +02:00			`- ZMB (Samba) Active Directory Domain Controller`
Added links for matrix 2021-04-09 19:08:28 +02:00			`- mailpiler mail archive [mailpiler.org](https://www.mailpiler.org/)`
			`- Matrix Synapse Homeserver [matrix.org](https://matrix.org/docs/projects/server/synapse) with Element Web [Element on github](https://github.com/vector-im/element-web)`
First version of README.md 2021-04-08 23:13:20 +02:00			`### Planned features / ideas for future releases`
			`- Nextcloud Server [nextcloud.com](https://nextcloud.com/)`
			`- check_mk RAW Edition [checkmk.com](https://checkmk.com)`
			`- Zabbix [zabbix.com](https://zabbix.com)`
			`- Abgleich control machine (ZFS Snapshot and Backup engine) [Abgleich on github](https://github.com/pleiszenburg/abgleich)`
Added Jitsi Meet to future ideas 2021-04-09 19:10:17 +02:00			`- Jitsi Meet server [jitsi.org](https://jitsi.org/jitsi-meet/)`
Added Kopano to ideas for future integrations 2021-04-09 19:55:10 +02:00			`- Kopano One [kopano.com](https://kopano.com/)`
First version of README.md 2021-04-08 23:13:20 +02:00			`## Usage`
			Just ssh into your Proxmox machine and clone this git repository. Make sure you have installed `git`.
			`### Clone this Repository`
			```bash
			`apt update`
			`apt -y install git`
			`git clone https://git.spille-edv.de/thorsten.spille/zamba`
			`cd zamba`
			```
			`### Configuration`
			To fit your requirements, please edit the file `zamba.conf` with your favourite test editor (e.g. `vim` or `nano`).
			`The required adjustments are in the LXC container section and in the section for the service you want to launch.`
Corrected spelling 2021-04-09 18:10:47 +02:00			`For further information about the config variables, have a look at [zamba.conf.md](zamba.conf.md)`
First version of README.md 2021-04-08 23:13:20 +02:00			`### Installation`
			`After configuring, you are able to launch the script interactively:`
			```bash
			`bash install.sh`
			```
Corrected documentation 2021-04-09 16:40:21 +02:00			`After container creation, you will be prompted to select the service to install and depending on the service there may be some more questions during installation.`
First version of README.md 2021-04-08 23:13:20 +02:00
Corrected documentation 2021-04-09 16:40:21 +02:00			`Once the script has finished, the container is installed and running and you can continue with the service specific configuration.`