Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit dd6400c4 authored by Felix Ableitner's avatar Felix Ableitner
Browse files

Update readme, change license to AGPL

parent b27c1cff
Loading
Loading
Loading
Loading
+661 −1

File changed.

Preview size limit exceeded, changes collapsed.

+43 −19
Original line number Diff line number Diff line
# Requirements
# Ecloud Selfhosting (Beta)

This project allows you to install ecloud services on your own server. It is the same
setup that is used on [ecloud.global](https://ecloud.global).

## Requirements

For the full setup, the following server hardware is recommended:

@@ -15,36 +20,43 @@ For the setup without OnlyOffice, requirements are a bit lower:
Disk space only refers to the basic installation. You will need additional space for any emails,
documents and files you store on the server.

### Required packages (these should be included with Ubuntu by default)
- curl
- bash
## Installation

# Installation
### Create Ubuntu VPS

## Create Ubuntu VM & set reverse DNS
This examplpes uses Hetzner cloud (sorry Gael ;)).
You can use whatever provider you want. Just make sure to set rdns correctly before running the
bootstrap script (works via Webui with some other hosters)
```
$ hcloud server create --image=ubuntu-18.04 --name server1 --type cx31 --ssh-key ts@treehouse-sss
$ hcloud server set-rdns server1 --hostname mail.example.com
```
The project should work with any Ubuntu VPS. Suggestions include [Hetzner](https://www.hetzner.com/cloud)
or [OVH](https://www.ovh.co.uk/vps/vps-ssd.xml). Hosting at home is also possible in principle,
but you will probably have problems with sending email (most providers will classify your email as spam).

First, create your VPS and point the domain at it. Then set the reverse DNS to the same domain
(this is usually possible in the VPS settings on the hoster's website).

In the following text, $DOMAIN refers to the domain that you configured for your selfhosting server.

### Start bootstrap process

Login to server as root. Execute this command and follow its on-screen instructions:

```
$ ssh root@$DOMAIN
# wget https://gitlab.e.foundation/e/infra/bootstrap/raw/master/bootstrap-generic.sh
# bash bootstrap-generic.sh https://gitlab.e.foundation/e/priv/infra/compose
```

**ATTENTION:**
You need to login to gitlab once during this step.
(repos will be public later making the bootstrapping run unattended)
### Manual account creation

A few services can't be configured automatically and need manual account creation to secure them:

# Available Services
**Rainloop**: It uses a hardcoded login by default, and can be accessed by anyone with a Nextcloud account.
To change it, visit https://$DOMAIN/apps/rainloop/app/?admin and enter username: `admin` and password: `12345`.
Go to the security tab to change the password.

You can find login information for these services by running `showInfo.sh`.
**OnlyOffice**: Open office.$DOMAIN, then follow the instructions to add a new admin user. This
is only necessary if you chose to install OnlyOffice.

## Available Services

You can find login information for these services by running `bash /mnt/repo-base/scripts/showInfo.sh`.

- $DOMAIN: File hosting with [Nextcloud](https://nextcloud.com/), email with
           [rainloop.net](https://www.rainloop.net/)
@@ -52,8 +64,20 @@ You can find login information for these services by running `showInfo.sh`.
                   `bash /mnt/repo-base/scripts/generate-signup-link.sh`)
- office.$DOMAIN: Create and edit office documents ([onlyoffice.com](https://www.onlyoffice.com/))

# Administration
## Administration

- spam.$DOMAIN: Email spam filter ([rspamd.com](https://www.rspamd.com/))
- mail.$DOMAIN: Administrate email and create accounts ([postfixadmin.sourceforge.net](http://postfixadmin.sourceforge.net/))

## Setting up /e/ OS with /e/ selfhosting

For a new installation, enter the selfhosting domain in the fist time usage wizard.

If you already have /e/ OS installed, you can add your selfhosting domain under
During installation, add your selfhosting domain in the first time usage wizard under
Settings->accounts->add /e/ account.

## License

The project is licensed under [AGPL](LICENSE).