README.md 2.55 KB
Newer Older
Vincent Sellier's avatar
Vincent Sellier committed
1
2
3
4
# Simplified self-hosted cozy cloud installation

:warning: Unofficial, not affiliated with cozy.io

i-vall's avatar
i-vall committed
5
Simplified procedure to run a personal cozy cloud with GrandLyon apps with docker.
Vincent Sellier's avatar
Vincent Sellier committed
6

i-vall's avatar
i-vall committed
7
Derived from vsellier's [easy-cozy](https://github.com/vsellier/easy-cozy).
Vincent Sellier's avatar
Vincent Sellier committed
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

## Prequisite

- A domain name
- A server with docker installed (linux **arm** or x86, MacOS) and accessible from Internet

## Domain configuration

Choose a cozy subdomain for you instance like `cozy.mydomain.tld`. Declare on your domain :

- a `A` entry with the ip of your server to `cozy.mydomain.tld`
- a `CNAME` entry `*.cozy.mydomain.tld` to `cozy.mydomain.tld`

## Cozy installation and configuration

i-vall's avatar
i-vall committed
23
- Clone the [easy-cozy](https://gitlab.alpha.grandlyon.com/cozy/easy-cozy) project
Vincent Sellier's avatar
Vincent Sellier committed
24

i-vall's avatar
i-vall committed
25
```sh
i-vall's avatar
i-vall committed
26
git clone https://gitlab.alpha.grandlyon.com/cozy/easy-cozy.git
Vincent Sellier's avatar
Vincent Sellier committed
27
28
```

i-vall's avatar
i-vall committed
29
- On the root directory of the project, create a `.env` file. You can use the [env.template](env.template) file as reference.
Vincent Sellier's avatar
Vincent Sellier committed
30

i-vall's avatar
i-vall committed
31
- By default, your first instance is named 'nicolas'. To change it, open the [install.sh](install.sh) script and modify the line where `create-instance.sh` is called.
Vincent Sellier's avatar
Vincent Sellier committed
32

i-vall's avatar
i-vall committed
33
- Start the server for the first time
Vincent Sellier's avatar
Vincent Sellier committed
34

i-vall's avatar
i-vall committed
35
36
```sh
sudo ./install.sh
Vincent Sellier's avatar
Vincent Sellier committed
37
```
i-vall's avatar
i-vall committed
38
39
This will start the containers, create the databases and create an instance with basic applications.
Open in a browser the url displayed at the end of the script output to finalize the instance configuration.
Vincent Sellier's avatar
Vincent Sellier committed
40

i-vall's avatar
i-vall committed
41
:+1: Congratulations you have now your own cozy cloud.
Vincent Sellier's avatar
Vincent Sellier committed
42

i-vall's avatar
i-vall committed
43
## Initialize more personal instance(s)
Vincent Sellier's avatar
Vincent Sellier committed
44

i-vall's avatar
i-vall committed
45
To add an instance `myuser.cozy.mydomain.tld`, run:
Vincent Sellier's avatar
Vincent Sellier committed
46

i-vall's avatar
i-vall committed
47
48
```sh
sudo ./create-instance.sh myuser
Vincent Sellier's avatar
Vincent Sellier committed
49
50
51
52
```

Open in a browser the url displayed at the end of the script output to finalize the instance configuration.

53
54
## Install applications

i-vall's avatar
i-vall committed
55
Default apps (drive, collect, settings, home) and GrandLyon apps (energy-dataviz) are installed by default by the [create-instance.sh](create-instance.sh) script. Other applications like [banks](https://github.com/cozy/cozy-banks) or [contacts](https://github.com/cozy/cozy-contacts) are also available.
56

57
You can go to the store application (`store.yourinstance.youdomain.tld`) to manage you applications.
58
To manually install an application, you can run the [application.sh](application.sh) script :
59

i-vall's avatar
i-vall committed
60
```sh
61
62
sudo ./application.sh <instance name> <application>
```
i-vall's avatar
i-vall committed
63
64
65
66
67
68
69
70
71

## Update applications

To update Grand Lyon applications and connectors, run:

```sh
sudo ./update.sh
```

i-vall's avatar
i-vall committed
72
## Reset your cozy
i-vall's avatar
i-vall committed
73

i-vall's avatar
i-vall committed
74
If for some reason you need to reset your cozy, simply re-run [install.sh](install.sh).
i-vall's avatar
i-vall committed
75
Careful, all the data and instances will be removed and you will have a new, clean cozy with basic apps.