diff --git a/README.md b/README.md index bc444ba..1fe14b0 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,16 @@ OpenGuestbook is a self-hosted lightweight Guestbook for small static websites m OpenGuestbook comes in two parts, a backend that needs to be hosted on a server, and a JS file that cn be embedded directly on your website. ### Backend deployment with Docker For production, running via Docker Compose is recommended. - +ssh in to your server and clone the repository: +``` +git clone https://code.gorkyver.com/Gorkem/OpenGuestbook.git +``` +get in directory and create docker-compose.yml: +``` +cd OpenGuestbook +nano docker-compose.yml +``` +Replace` ` with your static website url and `` with your [ntfy.sh topic](https://docs.ntfy.sh) to enable notificatons. #### 1) Create docker-compose.yml ```yaml version: '3.8' @@ -28,11 +37,16 @@ services: ports: - "5000:5000" volumes: - - ./guestbook_data:/openguestbook/guestbook # Persist comments on host to make it easily reachable + - ./guestbook_data:/OpenGuestbook/guestbook # Persist comments on host to make it easily reachable environment: - FRONTEND_URL= # if a frontend url is not provided the app will default the allow all utl's which is not recommended! - - NTFY_TOPIC= # for psuh notification support (optional) + - NTFY_TOPIC= # for psuh notification support (optional) ``` +build & run container with: +``` +docker compose up -d --build +``` +and your guesbook server should be up and running on port 5000 on your machine! -## Dependencies -## Configuration \ No newline at end of file +### Front-end Script +-To-do