Skip to content

Document createAdmin flag (single user mode) #218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
deiu merged 1 commit into from
Jan 27, 2016
Merged

Document createAdmin flag (single user mode) #218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@ node_modules/
*.swp
.tern-port
npm-debug.log
.acl
profile/
27 changes: 22 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ Options:
-C, --cert Path to the ssl cert file
--webid Enable WebID+TLS authentication
-idp, --identity-provider Allow registration of WebIDs
--create-admin Allow a user to set up their initial identity in single-user mode
-s, --secret HTTP Session cookie secret key (e.g. "your secret phrase")
-fU, --force-user Force a WebID to always be logged in (useful when offline)
-P, --proxy Use a proxy on example.tld/proxyPath
Expand All @@ -53,21 +54,37 @@ Options:

### Running the server

#### Solid server mode (HTTPS / WebID enabled)
#### Solid server, Single User mode (HTTPS / WebID enabled)

To start `ldnode` in Solid server mode, you will need to enable the `--webid`
flag, and also pass in a valid SSL key and certificate files:
To start `ldnode` in Solid Single User mode, you will need to enable the
`--webid` flag, and also pass in a valid SSL key and certificate files.
LDNode will use these certificates for its own server use (these are
different from the Admin user identity certificate discussed below).

**Initial Admin User Setup:**
The *first* time you run `ldnode`, you will also want to use the
`--create-admin` flag, to set up the initial Admin user identity and
certificates.

```bash
ldnode --webid --port 8443 --cert /path/to/cert --key /path/to/key --create-admin
```

You can then visit your LDNode server (at `https://localhost:8443/`, if you're
running it locally), and set up a new account.

You should then restart `ldnode`, this time without the `--create-admin` flag:

```bash
ldnode --webid --port 8443 --cert /path/to/cert --key /path/to/key
```

#### Solid server mode with WebID Identity Provider
#### Solid server, Multi-user Mode (Allows account creation)

To allow users to create a WebID on your server:

```bash
$ ldnode --webid --port 8443 --cert /path/to/cert --key /path/to/key -idp --root ./accounts
ldnode --webid --port 8443 --cert /path/to/cert --key /path/to/key -idp --root ./accounts
```

Your users will have a dedicated folder under `./accounts`. Also, your root domain's website will be in `./accounts/yourdomain.tld`.
Expand Down
2 changes: 1 addition & 1 deletion bin/ldnode.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ var argv = require('nomnom')
.option('createAdmin', {
full: 'create-admin',
flag: true,
help: 'Allow a user to set up its initial identity'
help: 'Allow a user to set up their initial identity in single-user mode'
})
.parse()

Expand Down