Skip to content

Commit 1a93a87

Browse files
Update for version 0.2.0
1 parent 5672be5 commit 1a93a87

File tree

2 files changed

+15
-7
lines changed

2 files changed

+15
-7
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# The NodeJS PhotoBackup server implementation
22

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

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

15-
photobackup init
15+
photobackup init <name>
1616

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

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

2325
## Usage
2426

2527
Launch the server with:
2628

27-
photobackup run
29+
photobackup run <name>
2830

29-
By default, it runs on host `0.0.0.0`, port `8420`.
31+
By default, it runs on `127.0.0.1:8420`.
32+
33+
## What names are for?
34+
35+
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.
36+
37+
The `name` parameter in `init` and `run` commands is optional. Without it, you init and run the default instance.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "photobackup",
3-
"version": "0.1.0",
3+
"version": "0.2.0",
44
"description": "PhotoBackup server implementation for Node.js",
55
"keywords": [
66
"photobackup",

0 commit comments

Comments
 (0)