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.
71 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 a5001ab732 Better error handling when .env not set
2024-08-17 20:47:07 +02:00
.vscode add extension recommendations 2024-08-17 01:05:57 +02:00
site Better error handling when .env not set 2024-08-17 20:47:07 +02:00
.gitignore serving social icons from static instead of using the ones from their sites (faster, does not set cookies from <website of icon>) 2020-12-05 22:23:37 +01:00
docker-compose.yml Better error handling when .env not set 2024-08-17 20:47:07 +02:00
Dockerfile Add change to compile with all threads again 2021-02-13 14:04:43 +01:00
Makefile clear makefile 2024-08-10 09:01:14 +02:00
README.md remove cookie token garbage 2024-08-10 09:41:01 +02:00

README.md

Crablog

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

Run instructions using docker

TODO REWRITE, OUTDATED

  1. Clone the repository
git clone https://github.com/mtrx1337/crablog
cd crablog/site
  1. Install diesel and create a database
cargo install diesel_cli --no-default-features --features "sqlite"
diesel setup --database-url ../content/db.sqlite3
diesel migration run --database-url ../content/db.sqlite3
  1. Set up your configuration file (see below)
  2. Pull the image (or build from source) and run the docker container
docker-compose up -d

Configuration environment file

All configuration options are defined in .env which should be placed in the path where crablog is run. An example configuration is provided:

.env

CL_USERNAME=yourusername
CL_EMAIL=me@mydomain.tld # optional
CL_BIND_PORT=8000 # optional
CL_SUBMIT_TOKEN=Submit!123 # required, token needed for submitting
CL_GITHUB_ACCOUNT=yourusername # optional
CL_TWITTER_ACCOUNT=yourusername # optional
CL_MASTODON_ACCOUNT=yourusername@mastodon.social # optional
CL_REDDIT_ACCOUNT=yourusername # optional
CL_DISCORD_ACCOUNT=yourusername # optional

# only needed when not using a docker container
CL_ROOT_PATH=/path/to/template/directory/and/sqliteDB

Routes

Route Description
/ shows the last 5 posts
/id/<id> shows a single post by id
/all shows all posts
/submit set your submit token and create posts
/edit/<id> edit, delete or hide posts
/about information about this blog, social media accounts

API Routes

Route Description
api/blog/posts returns all posts as json

Regenerate Migrations from Schema:

diesel migration generate --diff-schema=./src/db/schema.rs create_posts