diff --git a/README.md b/README.md index 3b74f75..223bd7a 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,25 @@ # Mozilla’s Sync Server for Yunohost +

+ yunohost status +

-The Sync Server provides a replacement for Firefox’s default server (hosted at Mozilla). Its code is available on [the Sync-1.5 Server documentation](https://docs.services.mozilla.com/howtos/run-sync-1.5.html) (no official documentation yet for the 1.6.x as it is really the bleeding edge version). +The Sync Server (ex Weaver) provides a replacement for Firefox’s default server (hosted at Mozilla). Its code is available on [the Sync-1.5 Server documentation](https://docs.services.mozilla.com/howtos/run-sync-1.5.html) (no official documentation yet for the 1.6.x as it is really the bleeding edge version). By default, a server set up will defer authentication to the Mozilla-hosted accounts server at [https://accounts.firefox.com](https://accounts.firefox.com). So you will still have to authenticate at Mozilla, but _the storage of your information will be done on your host_. -**Shipped version:** 1.6.2 +**Shipped Sync Server version:** 1.6.2 (still 1.5 API) -## Configuring +## Getting Started -Once installed, reaching `http://domain.tld/path` should show a page explaining how to configure it. Otherwise please refer to the [Yunohost page](https://yunohost.org/#/app_ffsync). +Install it with the current url via the admin interface, or for a verbose install using `sudo yunohost app install https://github.com/YunoHost-Apps/ffsync_ynh --verbose`. + +Once installed, reaching `http://domain.tld/path/` should show a page explaining how to configure it. Otherwise please refer to the [Yunohost page](https://yunohost.org/#/app_ffsync). + +

+ welcoming page +

## Contributing @@ -19,3 +30,11 @@ From the `sources` directory, do as follows: `make test` `./local/bin/gunicorn --reload --paste syncserver.ini` instead of the classical `make serve` to take into account changes you will surely do by developping the app. + +## Debug + +Apart from the typical `service ffsync status`, you might want to see what requests cause errors by coloring them: + +```bash +tail -f /var/log/ffsync.log | perl -pe 's/.*404.*/\e[1;31m$&\e[0m/g' +``` diff --git a/scripts/install b/scripts/install index 0fe8afe..1f8a0e1 100644 --- a/scripts/install +++ b/scripts/install @@ -69,7 +69,7 @@ sudo chown ffsync:ffsync -R $final_path sudo chown ffsync /var/log/ffsync.log # Modify Nginx configuration file and copy it to Nginx conf directory -sed -i "s@PATHTOCHANGE@$path@g" ../conf/nginx.conf +sed -i "s@PATHTOCHANGE@$path\/@g" ../conf/nginx.conf sed -i "s@ALIASTOCHANGE@$final_path/@g" ../conf/nginx.conf sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/ffsync.conf sudo cp ../conf/syncserver.ini $final_path/syncserver.ini