Skip to content
Sander van Dragt edited this page Oct 18, 2024 · 8 revisions

Lamb made out of circuitry

Lamb — Literally Another Micro Blog.

Barrier free super simple blogging, self-hosted. Read about the features.

Getting started

# Checkout project - release branch is stable
git clone --branch release https://github.com/svandragt/lamb.git
cd lamb

Lamb can be run locally with the builtin PHP webserver, or with other tooling, here are two ways to set this up:

a. DDev -- great for convenience,
b. Devbox — great for keeping a clean local system, OR
c. locally install PHP 8.2 and composer — great for neckbeards.

a. DDev

Make sure the tool's installed, then it will install prerequisites:

ddev start
# Run lamb - Change `hackme` to something more secure, this is the `/login` password!
ddev php make-password.php hackme

For more information see the DDev page.

b. Devbox

Make sure the tool's installed, then it will install prerequisites:

devbox shell

# In the shell from now on
composer install

# Run lamb - Change `hackme` to something more secure, this is the `/login` password!
LAMB_LOGIN_PASSWORD=$(php make-password.php hackme) composer serve

c. Locally installed PHP and Composer

You make sure everything is installed:

# Install required system packages, for example on Debian Linux derivates like Ubuntu
sudo apt update
sudo apt install php8.2 php8.2-gettext php8.2-mbstring php8.2-sqlite3 php8.2 php8.2-xml composer

# install project packages
composer install

# Run lamb - Change `hackme` to something more secure, this is the `/login` password!
LAMB_LOGIN_PASSWORD=$(php make-password.php hackme) composer serve

Support for development environments and deployment options is provided in the docs.

Site Configuration (optional)

Add a src/config.ini file with the following contents and update any of the following lines after uncommenting them:

;author_email = [email protected]
;author_name = Joe Sheeple
;site_title = My Microblog
;404_fallback = https://my.oldsite.com

Deployment options

Webservers:

  1. Caddy
  2. Nginx.

Containers:

  1. Docker

Devtools / local environments / sandbox:

  1. DDev local environments wrapper around Docker
  2. Devbox.

Topics

Clone this wiki locally