Skip to content

Commit

Permalink
add infos to Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
banglashi committed Feb 27, 2021
1 parent e14666a commit 48a020c
Showing 1 changed file with 26 additions and 7 deletions.
33 changes: 26 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ We appreciate filed issues, pull requests and general discussion.

# Features

- Create virtual whiteboards called *Spaces* with virtually unlimited size
- Create virtual whiteboards called _Spaces_ with virtually unlimited size
- Drag & drop images, videos and audio from your computer or the web
- Write and format text with full control over fonts, colors and style
- Draw, annotate and highlight with included graphical shapes
Expand Down Expand Up @@ -45,7 +45,6 @@ To install all node dependencies, run (do this once):

See [config/default.json](config/default.json). Set `storage_local_path` for a local sqlite database or `storage_region`, `storage_bucket`, `storage_cdn` and `storage_endpoint` for AWS S3. `mail_provider` may be one of `console` or `smtp`. Also, omit a trailing `/` for the `endpoint`.


## Disable DB logs

```json
Expand All @@ -61,7 +60,8 @@ Add a custom array of swatches to your config/default.json.
**You should include the swatch transparent (rgba(0,0,0,0)) so users can remove the color applied.**

## Configure default colors
You can define text, stroke and fill color in your config/default.json.

You can define text, stroke and fill color in your config/default.json.

**You also should include the default colors in your custom swatches palette.**

Expand Down Expand Up @@ -105,10 +105,30 @@ For advanced media conversion:
- audiowaveform for audio waveform rendering. Download: https://github.com/bbcrd/audiowaveform
- ghostscript for PDF import. Download: https://www.ghostscript.com/download/gsdnld.html

# Authentication

## LDAP

Add the [passport-ldapauth](https://github.com/vesse/passport-ldapauth) module

`npm install passport-ldapauth`

and edit config/default.json appropiately.

```
"auth_type": "ldap",
"auth_ldap_server": "ldaps://ad.corporate.com:636",
"auth_ldap_bind_dn": "cn=non-person,ou=system,dc=corp,dc=corporate,dc=com",
"auth_ldap_bind_credentials": "secret",
"auth_ldap_search_base": "dc=corp,dc=corporate,dc=com",
"auth_ldap_search_filter": "(uid={{username}})",
"auth_ldap_search_attributes": ["uid", "mail"]
```

# Data Storage

By default, media files are uploaded to the ```storage``` folder.
The database is stored in ```database.sqlite``` by default.
By default, media files are uploaded to the `storage` folder.
The database is stored in `database.sqlite` by default.

# Other databases (Not officially supported)

Expand All @@ -129,7 +149,6 @@ Adapt the other values as needed
"storage_password": "password",
```


# Run with Docker

- configure `config/default.json`
Expand All @@ -155,7 +174,7 @@ Spacedeck Open source code is released under the GNU Affero General Public Licen
Spacedeck Open - Web-based Collaborative Whiteboard For Rich Media
Copyright (C) 2011-2018 Lukas F. Hartmann, Martin Güther
Icons and original CSS design copyright by Thomas Helbig

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
Expand Down

0 comments on commit 48a020c

Please sign in to comment.