Skip to content

Commit

Permalink
Try to improve the documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Burgy Benjamin committed Dec 16, 2023
1 parent f9f7c7e commit a4c834d
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Ksuite-middleware

Project providing a single endpoint with a single API configuration to access to many resources from a KSuite environment.
Project providing a single endpoint to access to many resources from a KSuite environment. Currently the middleware supports only kDrive files and the calendar events.

![](diagram.png)

## Kdrive

Expand Down Expand Up @@ -47,14 +49,33 @@ services:
- 4000:4000
```
## Running with Docker (recommended way)
## Installation
### Running with [Docker](https://hub.docker.com/repository/docker/minidfx/ksuite-middleware) (recommended way)
With Docker, running the application is a breeze. Simply update the environment variables SECRET_KEY_BASE, PHX_HOST, KDRIVE_ID, and KSUITE_API_TOKEN. Then, run it to kickstart the application.
```bash
docker-compose up
```

### Clone this project and run it

1. Build it

```bash
export MIX_ENV=prod
mix deps.get && mix deps.compile && mix release
```

2. Set the environment variables

3. Run it!

```bash
_build/prod/rel/ksuite_middleware/bin/ksuite_middleware start
```

## Security considerations

This application doesn't offer any security layers or authentication. I suggest using a [proxy](https://docs.linuxserver.io/general/swag/) for TLS termination and authentication in front of the container. Make sure to protect this resource by yourself.
This application doesn't offer any security layers or authentication. Use this middleware behind a proxy like [swag](https://docs.linuxserver.io/general/swag/), [traefik](https://traefik.io/traefik) or any equivalent proxy.
Binary file added diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a4c834d

Please sign in to comment.