https://github.com/ivynya/sunset

Gracefully shut down websites.
https://github.com/ivynya/sunset

docker golang sunsetting

Last synced: 3 months ago
JSON representation

Gracefully shut down websites.

• Host: GitHub
• URL: https://github.com/ivynya/sunset
• Owner: ivynya
• License: gpl-2.0
• Created: 2022-11-26T23:34:58.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-12T18:34:20.000Z (over 1 year ago)
• Last Synced: 2025-01-26T09:24:15.565Z (over 1 year ago)
• Topics: docker, golang, sunsetting
• Language: CSS
• Homepage: https://ivy.direct/sunset
• Size: 303 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          

# Sunset

**Sunset** helps you easily and gracefully shut down websites while keeping your users informed.

![.github/image.png](.github/image.png)

Sunset can be deployed as a microservice to replace frontend components, to preserve database information past shutdown or background workflows running, keeping your site in a "read-only" mode (precluding API access).

Additionally, you can add custom messages to display to your users in Markdown, with support for most Markdown elements like links and images.

![.github/info.png](.github/info.png)

Built using Go, Fiber, and Docker, Sunset uses almost no resources and can be run with minimal server impact.

![.github/stats.png](.github/stats.png)

## How to deploy a Sunset instance

1. Clone this repository

2. Edit `public/message.md` with appropriate message for users

3. `docker build -t sunset:website .`

4. `docker run -p 3000:3000 -d sunset:website`

5. Edit your reverse proxy for your domain to point at `localhost:3000` on your server