Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cozy/cozy-setup

Cozy installation files and information
https://github.com/cozy/cozy-setup

Last synced: 8 days ago
JSON representation

Cozy installation files and information

Awesome Lists containing this project

README 

        
# Deprecated repository



**Important**: this repository is no longer maintained. If you want to install

Cozy Cloud, it's explained on [our website](https://docs.cozy.io/en/install/).



# Cozy Makes Your Web Apps Smarter



![Cozy Logo](https://raw.githubusercontent.com/cozy/cozy-setup/gh-pages/assets/images/happycloud.png)



[Cozy](http://cozy.io) is a platform that brings all your web services in the

same private space.  With it, your web apps and your devices can share data

easily, providing you

with a new experience. You can install Cozy on your own hardware where no one

profiles you.



See our [online demo](https://demo.cozycloud.cc/) to discover our applications.



## Project Tickets



* [Bug List](https://github.com/issues?q=is%3Aopen+is%3Aissue+user%3Acozy+label%3Abug+-repo%3Acozy%2Ftodos+-repo%3Acozy%2Fnotes+-repo%3Acozy%2Fcozy-editor+)

* [Feature Request List](https://github.com/issues?q=is%3Aopen+is%3Aissue+user%3Acozy+label%3Aenhancement+-repo%3Acozy%2Ftodos+-repo%3Acozy%2Fnotes+-repo%3Acozy%2Fcozy-editor+)

* [Opened Pull Requests](https://github.com/pulls?user=cozy)

* [Waiting tickets](https://github.com/issues?q=is%3Aopen+is%3Aissue+user%3Acozy+no%3Alabel+-repo%3Acozy%2Fcozy-guidelines)

* [Good tickets for a first contribution](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Acozy+label%3A%22Good+For+First+Contribution%22+-repo%3Acozy%2Ftodos+-repo%3Acozy%2Fnotes+-repo%3Acozy%2Fcozy-editor+)



## Install Cozy



Cozy Cloud is designed to be used remotely on your own server.

So, this project contains what you need to achieve that goal

(it only works for Debian/Ubuntu systems).



You will find all the steps to install Cozy on your platform on the [project site](https://docs.cozy.io/en/install/).



## Community



You can reach the Cozy community by:



* chatting with us on IRC #cozycloud on irc.freenode.net

* Posting on our [Forum](https://forum.cozy.io)

* Posting issues on the [Github repos](https://github.com/cozy/)

* Mentioning us on [Twitter](http://twitter.com/mycozycloud)



----



# Initial README.md



[Install script status](https://ci.cozycloud.cc/) for Debian 6, Debian 7,

Ubuntu 12.04 and Ubuntu 14.04.



## How to install Cozy on your server?



On your local machine install Fabric and fabtools. For that purpose, be sure to

have python and the pip tools on your machine. For instance, if you're on a

Debian based

distribution:



    apt-get install python python-pip python-dev software-properties-common



If you're on an Apple computer (MacBook and so on), you should already have

python and easy install tools, so you can just do:



    sudo easy_install pip



Once you have the pip tools installed on your machine:



    sudo pip install fabric fabtools



Download our Fabric file (a script that will run commands on your remote

server):



    wget https://raw.githubusercontent.com/cozy/cozy-setup/master/fabfile.py



Once your system is prepared, use the Fabric script from your local machine to

launch the Cozy installation (run it in the same directory as the fabfile

you downloaded before):



    fab -H user@ip install



Enter your settings when prompted by the installer.



Be patient; some commands or app deployments can take some time. It

depends on your network and hardware capabilities.



*About local installation*



To install Cozy locally, we recommend you to create a virtual machine,

and then to run the fabfile script with your virtual machine as target.

This allows you to experiment with Cozy without installing numerous packages

into your environment.



*Fabric authentifications issues*



Allow root login, put in ```/etc/ssh/sshd_config```:

```

PermitRootLogin yes

# Or prefer

PermitRootLogin without-password

```



Check Fabric connection:

```fab -u root -H cozy.domain.tld check_fab```



Use a user with right sudo config ```visudo```:

```

pi ALL=(ALL) NOPASSWD: ALL

```



Check Fabric connection:

```fab -u pi -H cozy.domain.tld check_fab```



Use sudo password:

```fab -u pi --password=raspberry -H cozy.domain.tld check_fab```



*Try Cozy with Vagrant*



If you want to use Vagrant to run Cozy Cloud Setup in a virtual machine

we recommend you use the Ubuntu 12.04 box. Be careful as the update will

require that you configure your boot sequence. Choose the first filesystem that

is offered, then click ok.



http://files.vagrantup.com/precise64.box



*Assistance*



You can either read our [Trouble

Shootings](http://cozy.io/host/trouble-shootings.html) section or contact us

via email [email protected] or join our IRC channel and ask for assistance

(#cozycloud on freenode.net).



## Recommended Hardware



The CPU is not a limitation, Cozy can even run on RaspberryPi.



### Mininum



RAM: 512MB (it allows to have 4 apps running simultaneously)

Disk space: 5GB

SD Class 10 for mini boards.



### Recommended



RAM: 2048 MB (it allows to have 15 apps simultaneously).

Disk space: a lot of space to store all your files.



## Test



Once the installation is done, you can access https://IP:443 to create your

Cozy main account. Be sure that you used the HTTPS protocol if you just see the

nginx welcome page.



## What will this script install on your server?



The Cozy install script installs the following tools:



* Python runtime

* Node.js runtime

* CouchDB document database

* Node tools: cozy-controller, cozy-monitor, coffee-script, brunch

* Cozy Controller Daemon

* Cozy Data Indexer

* Cozy Data System

* Cozy Proxy

* Cozy Home



If you want to know more about how Cozy works you can check our [architecture

page](https://docs.cozy.io/en/dev/intro/).



## About virtual machines and containers



Because of the numerous technologies involved, we recommend you to run the Cozy

stack in an isolated virtual machine or in a container (OpenVz or LXC). But

it's not mandatory, you can install Cozy Cloud on your server (that's

what you should do if you have a small server like a Sheeva Plug or an old

machine).



## License



Cozy is developed by Cozy Cloud under the AGPL v3 license (see each module for

exceptions).