Skip to content

Commit

Permalink
Add infos about authentication
Browse files Browse the repository at this point in the history
  • Loading branch information
onigoetz committed Dec 31, 2018
1 parent 915e0a0 commit 88d6a7b
Showing 1 changed file with 27 additions and 5 deletions.
32 changes: 27 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,11 @@ It is not intended to work on a desktop computer.

## Features

- Use basic auth credentials (from Nginx/Apache) or use the embedded Database to manage users.
- Watch your comic books on your phone or tablet, at home or on the go.
- Uses your filesystem, no need for a database
- Read images from a folder
- CBZ/CBR Files Support
- PDF Support
- Uses your filesystem, has an embedded database.
- Supports most comics formats : CBZ/CBR/ZIP/RAR, PDF, simple image directory.
- Internal search engine to find your comics easily
- Use basic auth credentials (from Nginx/Apache) or use the embedded Database to manage users.

## Installing

Expand Down Expand Up @@ -42,6 +40,30 @@ You can then start the server with `yarn start`.

This will index the books and start the server.

## Authentication

Authentication is an optional feature, you can either leverage the basic auth credentials from a server (Apache/Nginx)
Or use the built-in database.

This option can be changed in `config.js` with the `auth` configuration or the `COMICS_AUTH_TYPE` environment variable.
possible values are "basic" (default) or "db"

When using the "db" authentication mode, you need to create users, for this we provide a command-line tool to create them.

Note that the container has to be stopped in order to use the CLI tool as the database is otherwise readonly.

### Creating users

```bash
sudo docker run --rm -it -v your_images_dir:/comics onigoetz/comicsreader node comics createUser
```

### Changing password

```bash
sudo docker run --rm -it -v your_images_dir:/comics onigoetz/comicsreader node comics changePassword
```

## Tweaking the configuration

### Basedir
Expand Down

0 comments on commit 88d6a7b

Please sign in to comment.