Sign inSign up

jonmatum/draftmk-backend

By jonmatum

•Updated over 1 year ago

FastAPI backend for syncing docs and handling GitHub actions in DraftMk.

Image
Developer tools
0

356

jonmatum/draftmk-backend repository overview

⁠Draftmk Backend (Docker Image)

This repository contains the Docker configuration and API services for the Draftmk backend, built with FastAPI.

Note: This repository contains the backend logic and Docker deployment setup.

⁠Usage

You can run the backend container directly:

docker run -p 8888:8888 jonmatum/draftmk-backend

Or use Docker Compose:

docker-compose up --build

⁠Configuration

The backend service is configured using environment variables. When used with Docker Compose, you can define these in a .env file in the project root. Below is a list of supported variables:

VariableDescriptionDefault
GITHUB_REPOGitHub repository to sync markdown content—
GITHUB_BRANCHBranch name for GitHub syncmain
CONTENT_DIRPath to local markdown contentdocs
USE_S3Whether to use S3 as the content sourcefalse
S3_BUCKETName of the S3 bucket—
S3_PREFIXS3 prefix (folder path) for markdown filesdocs/

Make sure to include all required values in your .env file to ensure proper startup.

⁠Health Check

The container exposes a health check endpoint:

GET /health

Used by Docker and orchestration tools to confirm service readiness.

⁠Docker Hub Image

Pull the public image:

docker pull jonmatum/draftmk-backend:latest

⁠License

This Docker setup is provided under the MIT License.


echo "Pura Vida & Happy Coding!";

Tag summary

Content type

Image

Digest

sha256:0392acbf1…

Size

247.2 MB

Last updated

over 1 year ago

docker pull jonmatum/draftmk-backend