diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..e82f55c --- /dev/null +++ b/Dockerfile @@ -0,0 +1,11 @@ +# Start your image with a node base image +FROM node:22-alpine + +RUN npm install -g marp-ui + +ADD config.json /data/config.json +VOLUME /data + +EXPOSE 3000 + +CMD [ "marp-ui" ] diff --git a/README.md b/README.md index b77efa0..c65cc3c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,25 @@ # marp-ui-docker +This is a simple Docker container for running [marp-ui](https://codeberg.org/ric_harvey/marp-ui). + +** Warning ** +Run marp-ui only in a local environment or behind some authentication system, eg. using a reverse +proxy with authentication function! + +marp-ui does not provide any form of authentication by itself. It is a single-user system that enables +anyone who accesses it to see/edit/use all documents that are stored there. + +## Create container + +Run `docker build -t marp-ui .` to build the image locally. +marp-ui will be installed using npm into the image. + +Using `docker push /marp-ui:latest`, the image can be pushed to a +container registry. + +## Docker Compose + +A example `docker-compose.yaml` is provided for running marp-ui using marp-ui from my container +registry. + + diff --git a/config.json b/config.json new file mode 100644 index 0000000..33866a5 --- /dev/null +++ b/config.json @@ -0,0 +1,12 @@ +{ + "storagePath": "/data", + "autoSaveInterval": 30, + "preferredBrowser": "auto", + "defaultTheme": "default", + "mcpEnabled": false, + "editor": { + "fontSize": 14, + "tabSize": 2, + "wordWrap": true + } +} diff --git a/docker-compose.yaml b/docker-compose.yaml new file mode 100644 index 0000000..46c950d --- /dev/null +++ b/docker-compose.yaml @@ -0,0 +1,9 @@ +services: + marp-ui: + image: git.imzadi.de/acn/marp-ui:latest + restart: always + ports: + - 3000:3000 + volumes: + - marp-ui:/data +