Skip to content

Commit

Permalink
Update for version 0.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
stephanepechard committed Jul 11, 2016
1 parent 5672be5 commit 1a93a87
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 7 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# The NodeJS PhotoBackup server implementation

The NodeJS implementation of PhotoBackup server. It follows the
This is a [NodeJS](https://nodejs.org/) implementation of PhotoBackup server. It follows the
[official API](https://github.com/PhotoBackup/api/blob/master/api.raml).

## Installation
Expand All @@ -12,18 +12,26 @@ Install through [npm](https://www.npmjs.com/):
Then run the installer, which asks for the directory to save your pictures to
and the server password:

photobackup init
photobackup init <name>

This step creates a `~/.photobackup` file which contains:
This step creates a `~/.photobackup` file which contains, for every name:

* BindAddress, the IP address (default is 127.0.0.1) ;
* `MediaRoot`, the directory where the pictures are written in ;
* `Password`, the SHA-512 hashed password ;
* `Password`, the SHA-512 hashed password (for backward compatibility only, will soon be totally replaced the following) ;
* `PasswordBcrypt`, Bcrypt-ed version of the SHA-512 hashed password ;
* `Port`, the port (default is 8420).

## Usage

Launch the server with:

photobackup run
photobackup run <name>

By default, it runs on host `0.0.0.0`, port `8420`.
By default, it runs on `127.0.0.1:8420`.

## What names are for?

Names allow you to run several PhotoBackup instances on a same server. All instances are configured in the same `~/.photobackup` file. If you want to run instances concurrently, you'll need to set a different port to each instance.

The `name` parameter in `init` and `run` commands is optional. Without it, you init and run the default instance.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "photobackup",
"version": "0.1.0",
"version": "0.2.0",
"description": "PhotoBackup server implementation for Node.js",
"keywords": [
"photobackup",
Expand Down

0 comments on commit 1a93a87

Please sign in to comment.