Skip to content

Latest commit

 

History

History
66 lines (44 loc) · 2.23 KB

README.md

File metadata and controls

66 lines (44 loc) · 2.23 KB
Raw

Glass

Minimalist blog featuring syntax highlighting, images, comments, themes, RSS, and SEO out of the box.

CI Status Coverage Status Version Licence

Showcase

Glass draws its simplistic design inspiration from Medium and Gatsby - striving for minimalism and elegance like a pane of Glass. Glass allows you to quickly deploy a self-hosted blog in just a few simple steps.

Features

  • Custom image support per post (local storage or S3 configurable)
  • Comments (can be enabled/disabled)
  • Syntax highlighting for code snippets
  • Themes to style your blog instance
  • RSS feed so users can easily stay up-to-date with the latest posts via /feed
  • SEO out of the box with custom tags per post
  • Admin panel to manage posts, comments, categories, and users
  • ReCaptcha on user signup by populating the NOCAPTCHA_SECRET and NOCAPTCHA_SITEKEY env variables in production

Install

# Copy the env files, and edit as needed
cp src/.env-example src/.env && cp .env-example .env

# Run the setup script which will bootstrap all the requirements, spin up the service, and migrate the database
just setup

Install in Subdirectory (Optional)

There is a guide on how to do this here.

Usage

Visit glass.localhost in a browser to get started.

Default Login

The default login is admin@glass.com and password. Make sure to update the email/password after first login!

Deploy

# Deploy the project locally
just run

# Deploy the project in production
just prod

Development

# Get a comprehensive list of development tools
just --list