mtrx/crablog
1
0
Fork 0
Code Issues 12 Pull requests 1 Projects 1 Releases Packages Wiki Activity Actions
A blog software. It's meant to be as minimal as possible (thin client), while still maintaining basic readability and styling.
34 commits 2 branches 0 tags 165 KiB
Rust 58%
HTML 33.2%
JavaScript 3.8%
CSS 3.5%
Dockerfile 1.5%
Find a file
mtrx 3dab5f4ab0
Update README.md
2020-11-21 21:33:05 +01:00
content fixed html escaping and fixed env variable names 2020-11-21 21:17:33 +01:00
site fixed html escaping and fixed env variable names 2020-11-21 21:17:33 +01:00
.gitignore added html templates, static, index 2020-10-26 12:19:44 +01:00
docker-compose.yml should it die, we want it to restart 2020-11-17 18:05:49 +01:00
Dockerfile Dockerization and generalization of the project. Make it accessable for everyone 2020-11-17 18:01:54 +01:00
README.md Update README.md 2020-11-21 21:33:05 +01:00

README.md

Crablog

Pure rust. Built with actix, diesel, tera, serde and sqlite3.

Build instructions using docker

  1. Clone the repository
git clone https://github.com/leonardlorenz/crablog
cd crablog
  1. Set up your configuration file (see below)
  2. Build and run the docker container (Will compile from source and thus take a while)
docker-compose up -d

Configuration environment file

All configuration options are defined in .env, to be created in the same directory as this readme.

An example configuration:

USERNAME=yourusername
EMAIL=me@mydomain.tld
BIND_PORT=8000
ROOT_PATH=/path/to/template/directory/and/sqliteDB
SUBMIT_TOKEN=Submit!123 # token needed for submitting

Routes

  • / site welcome
  • /blog shows the last 5 posts
  • /blog/id/ shows a single post by id
  • /blog/all shows all posts
  • /blog/submit set your submit token and create posts
  • /blog/edit/ edit, delete or hide posts

API Routes

  • /api/blog/posts returns all posts as json