Update README about the hosted client.

master
Tom Hacohen 7 years ago committed by GitHub
parent 36cf88aaf2
commit 808c5111b8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -1,17 +1,40 @@
An EteSync web client. Use EteSync from the browser
# Status
# Usage
This project is not ready just yet, but it'll hopefully be soon.
**Note:** This is still in an early stage. It should perfectly safe to use (though
plase refer to the warning at the bottom) but you should expect bugs/bad design.
After it's ready you'll be able to run it locally and just use a full EteSync
client from the browser!
A live isntance is available on: https://client.etesync.com
We will also have a hosted version of this, but it's not as secure as running
your own. More info [here](https://www.etesync.com/faq/#web-client).
Please be advised that while it's probably safe enough to use the hosted client
in many cases, it's generally not preferable. It's recommended that you use signed
releases which's signature you manually verify and are run locally!
More info is available on the [FAQ](https://www.etesync.com/faq/#web-client).
## Running your own
You can either self-host your own client to be served from your own server, or
better yet, just run an instance locally.
First make sure you have `yarn` install.
Then clone this repository `yarn`, run `yarn` and wait until all of the deps are installed.
Then it's recommended you run `yarn build` to build a production ready client you should serve
(even if run locally!) and then just serve the `build` directory from a web server.
You could for exapmle use the python built-in web server by runnig `python3 -m http.server` from
the build directory.
Alternatively, you can run the debug server just to verify everything works. To do that,
run `yarn start`.
# Important!
There are some rough edges at the moment. For example, it uses a static IV
instead of a secure random generated one! Please DO NOT use this for any real
data and encryption keys until this warning is removed.
There are some rough edges at the moment, this project is still in early alpha!
While it's OK to use it for **accessing** your data, do **NOT** use it to create
new contacts/calendars while this notice is here! It uses a static IV for all
encryption operations at the moment, which is very bad!

Loading…
Cancel
Save