open source imageboard.

Related tags

Laravel shuzu
Overview

Shuzu

an opensource imageboard written in PHP.


Set-up

To get shuzu running, you need to meet the prerequisites.

Prerequisites

For shuzu to work, it needs to be in this environment:

  • A PHP version that is greater than 8.0 (version's lower than 8.1 weren't tested!).
  • SQLite, image-magick extensions installed and enabled.
  • An empty subdomain. Shuzu can't run in a subdirectory because of its heavy reliance on routing.

Installation

  • Pull the repo inside an empty directory. git clone https://github.com/japannt/shuzu.git
  • Follow the instructions in the section below.

Updating?

The easiest way to keep up with shuzu updates is to use git and pull to the repository sporadically.

Configuration

Configuring shuzu:

Copy config.default.php to config.php then edit the newly copied file.

Configuring the webserver

Enable the general webserver file-serving, and execute php as normal.
Important! Use the router /index.php only when the server is about to yield a 404 error!

Example webserver configuration(s):

Caddy:

shuzu.example.com {
	root public

	php_fastcgi unix//run/php-fpm/php-fpm.sock {
		index /index.php
		try_files {path} {path}/index.php /index.php
	}

	file_server {
		index off
	}

	try_files {path} {path}/index.php
}

PR's for the readme on configurations for other webservers will be welcome!

Configuring the database

Shuzu will not work out of the box, it needs to be configured. Thankfully it's easy to do so.

  • After configuring the webserver, navigate to /admintool and authenticate with the login and password you set up earlier.
  • Look for the !!! NUCLEAR OPTIONS !!! section and click the nuke button.
  • After the database is nuked, you can start configuring everything else.

Do note, that the admintool isn't finished and is mostly in a dire state. pending rewrite.

Adding banners

To add new banners, put your banner to /images/banners/{board} (Create if doesn't exist).
Every banner should have a resolution of 468x80px.

Shuzu each time will pick a random banner.

Good practice

It's generally a good idea to do these if you ask me.

  • Restrict the users from accessing anything that isn't in /public.
  • Use a strong password for the administration tool, and don't share it at all.
  • Use SSL for god’s sake. (so many imageboards don't have SSL enabled.)

TODO

  • Working Functional release.
  • Fix media handling.
  • Proper configuration file.
  • Sticky threads.
  • User banning.
  • admintool rewrite.
  • Captcha.

Demo

A full instance of shuzu is available at shuzu.new-japannt.tk, have fun!

You might also like...
An Easy, Customizable & Open Source Robux Rewards Website Made With Laravel
An Easy, Customizable & Open Source Robux Rewards Website Made With Laravel

RbxDream - Robux Earning Rewards Website Coming Soon Current repo not stable. This is an open source Robux rewards site. Understanding Core Concepts T

An open-source Laravel library for building high-quality, accessible applications and administration dashboards.
An open-source Laravel library for building high-quality, accessible applications and administration dashboards.

Arpite An open-source Laravel library for building high-quality, accessible applications and administration dashboards. Built using Inertia.js, React,

Open source for selling social media accounts or accounts on other platforms.

SELLACC - Open Source Selling Accounts SELLACC is open source for selling social media accounts or accounts on other platforms. ⚠️ We not update sourc

Electrik is a full-featured, open-source, starter-kit to help you build you your SaaS application.
Electrik is a full-featured, open-source, starter-kit to help you build you your SaaS application.

Electrik Electrik is a full-featured and open-source stater-kit for for your next SaaS application. It's built on top of Laravel, Livewire, neerajsoha

Open Food Facts API wrapper for Laravel

Laravel Open Food Facts API This package provides a convenient wrapper to the Open Food Facts API for Laravel applications (5.7+). Installation You ca

A package that makes it easy to have the `artisan make:` commands open the newly created file in your editor of choice.

Open On Make A package that makes it easy to have the artisan make: commands open the newly created file in your editor of choice. Installation compos

A Laravel package to fetch Open Graph data of a website.
A Laravel package to fetch Open Graph data of a website.

OpenGraph is a laravel package to fetch Open Graph metadata of a website/link. Features Easily fetch metadata of a URL. Laravel OpenGraph fetches all

A Laravel URL Shortener package that provides URL redirects with optionally protected URL password, URL expiration, open limits before expiration

A Laravel URL Shortener package that provides URL redirects with optionally protected URL password, URL expiration, open limits before expiration, ability to set feature activation dates, and click tracking out of the box for your Laravel applications.

Source code behind the Laracasts Larabit: Creating and Using Custom Blade Directives

This is the source code behind the Laracasts Larabit: Creating and Using Custom Blade Directives, and features all of the files and code available in that video.

Owner
japan
i am a ""human"" that likes staring at code for 30 hours and then see where i made a typo.
japan
📛 An open source status page system for everyone.

Cachet is a beautiful and powerful open source status page system. Overview List your service components Report incidents Customise the look of your s

Cachet 13k Dec 3, 2022
Open Source Invoicing Solution for Individuals & Businesses

Introduction Crater is an open-source web & mobile app that helps you track expenses, payments & create professional invoices & estimates. Web Applica

Crater Invoice 6.7k Dec 1, 2022
Freelancer notes is an open source web application

#What is Freelancer Notes Freelancer Note is an freelance project management application. It is very light weight and easy to use. You are able to man

Porimol Chandro 51 Sep 22, 2022
ergodnc (Ergonomic Desk & Coffee) is an open source Laravel project that's being built live on the official Laravel YouTube Channel

About This Project ergodnc (Ergonomic Desk & Coffee) is an open source Laravel project that's being built live on the official Laravel YouTube Channel

Mohamed Said 243 Nov 28, 2022
PHPBack is an open source feedback system

About PHPBack is an open source feedback system you can use for your website. It gives your customers a way to communicate their ideas to improve your

PHPBack 371 Nov 9, 2022
This is an open source demo of administration panel for polymorphic relationship and SEO content

Laravel SEO admin This application demonstrates usage of polymorphic relationships described at (http://maxoffsky.com/code-blog/using-polymorphic-rela

Maksim Surguy 127 Oct 11, 2022
An open source Laravel Soundboard with Admin Panel CRUD (Create Read Update Delete) built on Laravel, Bootstrap, and Vue.js

Laravel Soundboard An open source Laravel Soundboard with Admin Panel CRUD (Create Read Update Delete) built on Laravel 5.8, Bootstrap 4, Vue.js, Boot

Jeremy Kenedy 24 Oct 28, 2022
An issue tracking tool based on laravel+reactjs for small and medium-sized enterprises, open-source and free, similar to Jira.

ActionView English | 中文 An issue tracking tool based on php laravel-framework in back-end and reactjs+redux in front-end, it's similar to Jira. You co

null 1.7k Nov 24, 2022
Free and open-source Laravel admin dashboard interface built with Livewire & Alpine.js based on Bootstrap 5

Volt Dashboard Laravel Free Frontend Web App for Laravel with Livewire & Alpine.js Never start a development project from scratch again. We've partner

Themesberg 197 Dec 5, 2022
Attendize is an open-source ticketing and event management application built using the Laravel PHP framework

Attendize is an open-source ticketing and event management application built using the Laravel PHP framework. Attendize allows event organisers to sel

Attendize 3.5k Nov 30, 2022