Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leighmcculloch/docker-unison
A docker data container using Unison for fast folder sync. An alternative to slow boot2docker volumes on OS X.
https://github.com/leighmcculloch/docker-unison
Last synced: about 2 months ago
JSON representation
A docker data container using Unison for fast folder sync. An alternative to slow boot2docker volumes on OS X.
- Host: GitHub
- URL: https://github.com/leighmcculloch/docker-unison
- Owner: leighmcculloch
- License: gpl-3.0
- Archived: true
- Created: 2015-04-19T12:17:36.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-12-08T05:24:17.000Z (almost 5 years ago)
- Last Synced: 2024-04-10T05:45:53.191Z (6 months ago)
- Language: Shell
- Homepage:
- Size: 4.73 MB
- Stars: 167
- Watchers: 11
- Forks: 26
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-docker - Docker Unison - way folder sync. Created as an alternative to slow boot2docker volumes on OS X. By [@leighmcculloch](https://github.com/leighmcculloch) (Container Operations / Volume Management / Data)
- awesome-docker - Docker Unison - way folder sync. Created as an alternative to slow boot2docker volumes on OS X. By [@leighmcculloch](https://github.com/leighmcculloch) (Container Operations / Volume Management / Data)
README
# Docker-Unison
**This project is no longer maintained. If you would like to take over maintaining, please fork.**
A docker volume container using [Unison](http://www.cis.upenn.edu/~bcpierce/unison/) for fast two-way folder sync. Created as an alternative to [slow boot2docker volumes on OS X](https://github.com/boot2docker/boot2docker/issues/593).
The docker image is available on Docker Hub:
[registry.hub.docker.com/u/leighmcculloch/unison/](https://registry.hub.docker.com/u/leighmcculloch/unison/)
## Usage
### Docker
First, you can launch a volume container exposing a volume with Unison.
```bash
$ CID=$(docker run -d -p 5000:5000 -e UNISON_WORKING_DIR=/unison -v /unison leighmcculloch/unison:latest)
```
You can then sync a local folder to `/unison` in the container with:
```bash
$ unison . socket://:5000/ -auto -batch
```
Next, you can launch a container connected with the volume under `/unison`.
```bash
$ docker run -it --volumes-from $CID ubuntu /bin/sh
```
### Docker Compose
If you are using Docker Compose to manage a dev environment, use the `volumes_from` directive.
The following `docker-compose.yml` would mount the `/unison` folder from the `unison` container inside your `mywebserver` container.
```yaml
mywebserver:
build: .
volumes_from:
- unison
unison:
image: leighmcculloch/unison:latest
environment:
- UNISON_WORKING_DIR=/unison
volumes:
- /unison
ports:
- "5000:5000"
```
You can then sync a local folder, using the unison client, to `/unison` in the container with:
```bash
$ unison . socket://:5000/ -ignore 'Path .git' -auto -batch
```
You could combine it with fswatch to sync automatically when files change:
```bash
$ fswatch -o . | xargs -n1 -I{} unison . socket://:5000/ -ignore 'Path .git' -auto -batch
```
## Installing Unison Locally
Unison requires the version of the client (running on the host) and server (running in the container) to match.
* 2.40.102 (available via `apt-get install unison` on Ubuntu 14.04, 14.10, 15.04) [compiled with ocaml 4.01]
* 2.48.3 (available via `brew install unison` on Mac OS X) [compiled with ocaml 4.02]
## Available Unison Images
This docker repository includes common versions of Unison server compiled with different versions of OCaml. The version you need can be selected by choosing the appropriately tagged image from the docker hub repository. Images are tagged in the format:
```
VERSION-[unisonUNISON_VERSION[-OCAML_VERSION]]
```
Supported versions are any combination of the following:
* Unison 2.40.102 and 2.48.3
* OCaml 4.01 and 4.02
Additional versions can be added easily on request. Open an Issue if you need another version.
### Examples
| Docker Image Tag | Unison | OCaml |
| ------------------------------------------------------- | ---------- | ------- |
| `leighmcculloch/unison:latest` | `2.48.3` | `4.02` |
| `leighmcculloch/unison:latest-unison2.48.3` | `2.48.3` | `4.02` |
| `leighmcculloch/unison:latest-unison2.48.3-ocaml4.02` | `2.48.3` | `4.02` |
| `leighmcculloch/unison:latest-unison2.48.3-ocaml4.01` | `2.48.3` | `4.01` |
| `leighmcculloch/unison:latest-unison2.40.102` | `2.40.102` | `4.02` |
| `leighmcculloch/unison:latest-unison2.40.102-ocaml4.02` | `2.40.102` | `4.02` |
| `leighmcculloch/unison:latest-unison2.40.102-ocaml4.01` | `2.40.102` | `4.01` |
## Installing fswatch Locally
Get fswatch using `brew install fswatch` on Mac OS X otherwise [download and compile from a release build](http://emcrisostomo.github.io/fswatch/).
## License
This docker image is licensed under GPLv3 because Unison is licensed under GPLv3 and is included in the image. See LICENSE.