YunoHost-Apps/ffsync_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/ffsync_ynh.git synced 2024-09-03 18:26:38 +02:00
Code Issues Activity Actions

fixed sed error at install and updated README.md

Browse source
This commit is contained in:
Pierre-Antoine Rault 2017-03-12 20:58:00 +01:00
parent fd6350495d
commit 325152b352
2 changed files with 24 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -1,14 +1,25 @@
# Mozilla’s Sync Server for Yunohost # Mozilla’s Sync Server for Yunohost
<p align="left">
<img src="https://img.shields.io/badge/status-working-green.svg"
alt="yunohost status">
</p>
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_. 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).
<p align="center">
<img src="https://cloud.githubusercontent.com/assets/6329880/23835111/c6e20640-0761-11e7-8f07-00e76198ac6b.png"
alt="welcoming page">
</p>
## Contributing ## Contributing
@ -19,3 +30,11 @@ From the `sources` directory, do as follows:
`make test` `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. `./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'
```

2
scripts/install
View file

@ -69,7 +69,7 @@ sudo chown ffsync:ffsync -R $final_path
sudo chown ffsync /var/log/ffsync.log sudo chown ffsync /var/log/ffsync.log
# Modify Nginx configuration file and copy it to Nginx conf directory # 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 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/nginx.conf /etc/nginx/conf.d/$domain.d/ffsync.conf
sudo cp ../conf/syncserver.ini $final_path/syncserver.ini sudo cp ../conf/syncserver.ini $final_path/syncserver.ini