Skip to content

Latest commit

 

History

History
75 lines (50 loc) · 2.23 KB

README.md

File metadata and controls

75 lines (50 loc) · 2.23 KB

Cozy-Toolbox

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.

Cozy-Toolbox

Cozy-Toolbox is a web application that can be used to browse data of Cozy instances. It is similar to CouchDB fauxton, but more adapted to Cozy.

How to start?

To start your Phoenix server:

  • Run mix setup to install and setup dependencies
  • Start Phoenix endpoint with mix phx.server or inside IEx with iex -S mix phx.server

Now you can visit localhost:5900 from your browser.

If you need to configure the CouchDB to use, you can use the TOOLBOX_DB_AUTH and TOOLBOX_DB_URL env variables:

$ TOOLBOX_DB_AUTH=user:p4ssw0rd TOOLBOX_DB_URL=http://couch:5984 iex -S mix phx.server

How to connect to an external server?

It's possible to use a ssh tunnel and create your own environment:

$ ssh -L 5981:ha-couch-int.service.consul-dev:5984 bounce
$ $EDITOR config/my_int.exs
$ cat config/my_int.exs
import Config

config :toolbox, Web.Endpoint,
  db_url: "http://localhost:5981",
  db_auth: "user:password"

config :toolbox, Web.Endpoint,
  http: [ip: {127, 0, 0, 1}, port: 5001],
  secret_key_base: "oNFl6+gGBO5PPUsq2CgFhS/SdsHsYDzi7Y+ZZfwdNb042LjozGmypJGtwWH95rfp"

config :logger, :console, format: "[$level] $message\n"
$ MIX_ENV=my_int iex -S mix phx.server
$ $BROWSER http://localhost:5001

Note: the db_auth with user:password must be changed to real credentials!

Community

You can reach the Cozy Community by:

License

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

Credits

The wallpaper for the home is a photo taken by Boris Renner, licensed as CC-by-sa 3.0. See https://commons.wikimedia.org/wiki/File:Lampovna_narodni_kulturni_pamatky_dolu_michal_2008.jpg for more details.