excalidraw-storage-backend/README.md

# 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)

Feature:

- Storing scenes: when you export as a link
- Storing rooms: when you create a live collaboration
- Storing images: when you export or do a live collaboration of a scene with images

It use Keyv as a simple K/V store so you can use the database of your choice.

## Environement Variables

| Name            | Description                                                  | Default value    |
| --------------- | ------------------------------------------------------------ | ---------------- |
| `PORT`          | Server listening port                                        | 8080             |
| `GLOBAL_PREFIX` | API global prefix for every routes                           | `/api/v2`        |
| `STORAGE_URI`   | [Keyv](https://github.com/jaredwray/keyv) connection string, example: `redis://user:pass@localhost:6379`. Availabe Keyv storage adapter: redis, mongo, postgres and mysql  | `""` (in memory **non-persistent**) |
| `LOG_LEVEL`     | Log level (`debug`, `verbose`, `log`, `warn`, `error`)       | `warn`           |
| `BODY_LIMIT`    | Payload size limit for scenes or images                      | `50mb`           |
Initial commit 2021-09-06 15:07:04 +00:00			`# excalidraw-storage-backend`

docs: add small presentation 2021-09-08 17:54:32 +02:00			`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)`

docs: add feature description 2021-12-01 18:12:47 +01:00			`Feature:`

			`- Storing scenes: when you export as a link`
			`- Storing rooms: when you create a live collaboration`
			`- Storing images: when you export or do a live collaboration of a scene with images`

			`It use Keyv as a simple K/V store so you can use the database of your choice.`

feat: support multiple database 2021-09-08 15:31:02 +02:00			`## Environement Variables`

feat: add more configurable options 2021-09-08 17:17:39 +02:00			`\| Name \| Description \| Default value \|`
			`\| --------------- \| ------------------------------------------------------------ \| ---------------- \|`
			\| `PORT` \| Server listening port \| 8080 \|
			\| `GLOBAL_PREFIX` \| API global prefix for every routes \| `/api/v2` \|
feat: add body size limit config as env var 2021-12-01 17:16:54 +01:00			\| `STORAGE_URI` \| [Keyv](https://github.com/jaredwray/keyv) connection string, example: `redis://user:pass@localhost:6379`. Availabe Keyv storage adapter: redis, mongo, postgres and mysql \| `""` (in memory non-persistent) \|
feat: use nest logger and support log level env var 2021-11-25 15:14:15 +01:00			\| `LOG_LEVEL` \| Log level (`debug`, `verbose`, `log`, `warn`, `error`) \| `warn` \|
feat: add body size limit config as env var 2021-12-01 17:16:54 +01:00			\| `BODY_LIMIT` \| Payload size limit for scenes or images \| `50mb` \|