You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
46 lines
1.9 KiB
Markdown
46 lines
1.9 KiB
Markdown
<p align="center">
|
|
<img width="120" src="src/images/logo.svg" />
|
|
<h1 align="center">EteSync - Secure Data Sync</h1>
|
|
</p>
|
|
|
|
The EteSync Web App - Use EteSync from the browser!
|
|
|
|
|
|
|
|
[](https://webchat.freenode.net/?channels=#etesync)
|
|
|
|
# Usage
|
|
|
|
**Note:** This is still in an early stage, but it should be safe to use. It uses the battle
|
|
tested [sjcl](https://crypto.stanford.edu/sjcl/) javascript crypto library for encryption,
|
|
so that should be fine too.
|
|
|
|
A live instance is available on: https://client.etesync.com
|
|
|
|
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 example, use the python built-in web server by running `python3 -m http.server` from
|
|
the build directory.
|
|
|
|
Alternatively, you can run the debug server just to verify everything works,
|
|
though be aware that the app will probably be quite slow. To do that, run `yarn start`.
|
|
|
|
### Serving from a subdirectory
|
|
|
|
In order to run your own version and serve it from a subdirectory rather than the top level of the domain, add `"homepage": "/subdir-name"` to the `package.json` file.
|