mirror of
https://github.com/pawelmalak/flame.git
synced 2024-11-04 13:59:04 +03:00
Updated Authentication (markdown)
parent
08f5d3f796
commit
374f2f7599
@ -1 +1,48 @@
|
||||
wip
|
||||
# THIS FEATURE IS STILL IN DEVELOPMENT
|
||||
|
||||
### Set custom password
|
||||
To set your own password, simply pass `PASSWORD=your_password` environment variable to your `docker run` command or your `docker-compose` file.
|
||||
|
||||
> If custom password is not provided, default password `flame_password` will be used.
|
||||
|
||||
- Command example
|
||||
```bash
|
||||
docker run -p 5005:5005 -v /path/to/data:/app/data -e PASSWORD=my_password flame
|
||||
```
|
||||
|
||||
- File example
|
||||
```yaml
|
||||
version: '2.1'
|
||||
services:
|
||||
flame:
|
||||
image: pawelmalak/flame:latest
|
||||
container_name: flame
|
||||
volumes:
|
||||
- <host_dir>:/app/data
|
||||
ports:
|
||||
- 5005:5005
|
||||
environment:
|
||||
- PASSWORD=my_password
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
### Login
|
||||
To login, go to `Settings > App`. Authentication section contains form with two inputs:
|
||||
- **password**: your password
|
||||
- **session duration**: how long auth token should be valid for
|
||||
|
||||
### Visibility
|
||||
Authenticated user has access to:
|
||||
- all apps
|
||||
- all categories
|
||||
- all bookmarks
|
||||
- all editors
|
||||
- all settings
|
||||
|
||||
Guest user has access to:
|
||||
- x
|
||||
- categories set to public
|
||||
- bookmarks set to public
|
||||
- Theme and App sections of settings
|
||||
|
||||
> If category is set to `hidden`, all bookmarks associated with it will also be hidden. Setting `visible` on specific bookmark **will not be respected**.
|
Loading…
Reference in New Issue
Block a user