Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/clipr/sync-provider

Clipr Sync provider implementation
https://github.com/clipr/sync-provider

Last synced: 3 months ago
JSON representation

Clipr Sync provider implementation

Awesome Lists containing this project

README

        

# Clipr Sync Provider
> Clipr Sync provider implementation

Alternative sync provider for clipr.
Can be installed on your server or your local network to be used instead of the built-in sync service.

## Installation

* Clone the repo
* Make sure [docker](https://www.docker.com/) and [docker-compose](https://docs.docker.com/compose/) is installed
* edit `docker-compose.yml` to change the couchDB credentials and/or the listening ports
* In the cloned directory run: `docker-compose up` to build and start the service
* Finish the installation of your local couchDB by going to [http://localhost:5984/_utils](http://localhost:5984/_utils) (or you server url) and then to **Setup**
* Go to **Configuration** and **Enable CORS** in the **CORS** menu. You can edit the other couch settings as you see fit

## Usage

After the service is built and configured you can point your clipr installation to it by enabling
the **use alternative sync provider** in the settings tab and adding your installation's url.

![](repo_assets/settings.png)

## Meta

[https://clipr.cloud](https://clipr.cloud) – [email protected]

Distributed under the AGPL-3.0 license. See ``LICENSE`` for more information.

[https://github.com/clipr](https://github.com/clipr/)

## Contributing

1. Fork it ()
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Commit your changes (`git commit -am 'Add some fooBar'`)
4. Push to the branch (`git push origin feature/fooBar`)
5. Create a new Pull Request