Skip to content

Latest commit

 

History

History
79 lines (49 loc) · 2.51 KB

README.md

File metadata and controls

79 lines (49 loc) · 2.51 KB
Raw

Cozy Proxy

Cozy Proxy redirects requests properly to the right application of the Cozy platform depending on given path. It also handles authentication to the Cozy for users and devices.

Install

We assume here that the Cozy platform is correctly installed on your server.

Type this command to install the proxy module:

cozy-monitor install proxy

Contribution

You can contribute to the Cozy Proxy in many ways:

  • Pick up an issue and solve it.
  • Translate it in a new language.
  • Improve the session management.

Hack

To be hacked, the Cozy Proxy dev environment requires that a CouchDB instance and a Cozy Data System instance are running. Then you can start the Cozy Proxy this way:

git clone https://github.com/mycozycloud/cozy-proxy.git
node server.js

Each modification requires a new build, here is how to run a build:

cake build

To hack cozy-proxy using the cozy vagrant

  • Forward a new port from the virtual machine (for example: config.vm.network :forwarded_port, guest: 9555, host: 9555 in file Vagrantfile)
  • Go in the shared folder cd /vagrant and cd your-cozy-proxy-folder
  • rm -rf node_modules/bcrypt && npm install
  • Launch cozy-proxy PORT=9555 HOST="0.0.0.0" coffee server.coffee
  • You can now access the hacked proxy on http://localhost:9555 with your navigator

Tests

Build Status

To run tests type the following command into the Cozy Home folder:

cake tests

Icons

by iconmonstr

License

Cozy Proxy is developed by Cozy Cloud and distributed under the AGPL v3 license.

What is Cozy?

Cozy Logo

Cozy 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.

Community

You can reach the Cozy Community by:

  • Chatting with us on IRC #cozycloud on irc.freenode.net
  • Posting on our Forum
  • Posting issues on the Github repos
  • Mentioning us on Twitter