Skip to content
Normal view History Permalink
README.md 1.11 KiB
Newer Older
Pierre Ozoux's avatar
Initial commit
Pierre Ozoux committed
1 
# remoteStorage
Pierre Ozoux's avatar
first commit  
Pierre Ozoux committed
2 3 4 

An open protocol for per-user storage
Sebastian Kippe's avatar
Update README.md  
Sebastian Kippe committed
5 
![logo](https://cdn.rawgit.com/remotestorage/design/master/logo-new/icon.svg)
Pierre Ozoux's avatar
first commit  
Pierre Ozoux committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 

# How to use this image

The easiest is to use our `docker-compose.yml`.

Make sure you have [docker-compose](http://docs.docker.com/compose/install/) installed. And then:

```
git clone https://github.com/indiehosters/remoteStorage.git
cd remoteStorage
docker-compose up
```

You can now access your instance on the port 80 of the IP of your container.

## Accees it from Internet
Pierre Ozoux's avatar
Better instructions  
Pierre Ozoux committed
23 24 
We recommend the usage of SSL, so the easiest is to modify the `apache.conf` file, you can find examples [here](https://github.com/fkooman/php-remote-storage/blob/master/contrib/storage.local.conf.ubuntu).
Rebuild the image once done.
Pierre Ozoux's avatar
first commit  
Pierre Ozoux committed
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 

Once it is done, you can connect to the port of the host by adding this line to `docker-compose.yml`:
```
web:
...
  - ports:
    - "443:443"
    - "80:80"
...
```

## Contribute

Pull requests are very welcome!

We'd love to hear your feedback and suggestions in the issue tracker: [github.com/indiehosters/remoteStorage/issues](https://github.com/indiehosters/remoteStorage/issues).