sambruk/excalidraw-storage-backend
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add small presentation

Browse Source
This commit is contained in:
Kilian Decaderincourt 2021-09-08 17:54:32 +02:00
parent b8a6be8c34
commit 57a173e1b9
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -1,11 +1,17 @@
# excalidraw-storage-backend # excalidraw-storage-backend
This is a reimplementation of [excalidraw-json](https://github.com/excalidraw/excalidraw-json) suitable for self hosting you own instance of Excalidraw.
It can be used with [kiliandeca/excalidraw-fork](https://gitlab.com/kiliandeca/excalidraw-fork)
[DockerHub kiliandeca/excalidraw-storage-backend](https://hub.docker.com/r/kiliandeca/excalidraw-storage-backend)
## Environement Variables ## Environement Variables
| Name | Description | Default value | | Name | Description | Default value |
| --------------- | ------------------------------------------------------------ | ---------------- | | --------------- | ------------------------------------------------------------ | ---------------- |
| `PORT` | Server listening port | 8080 | | `PORT` | Server listening port | 8080 |
| `GLOBAL_PREFIX` | API global prefix for every routes | `/api/v2` | | `GLOBAL_PREFIX` | API global prefix for every routes | `/api/v2` |
| `STORAGE_URI` | [keyv](https://github.com/lukechilds/keyv) connection string | `""` (in memory) | | `STORAGE_URI` | [Keyv](https://github.com/lukechilds/keyv) connection string | `""` (in memory) |
Availabe storage adapter: redis, mongo, postgres and mysql Availabe Keyv storage adapter: redis, mongo, postgres and mysql