Skip to content

Latest commit

 

History

History
104 lines (73 loc) · 2.8 KB

README.md

File metadata and controls

104 lines (73 loc) · 2.8 KB
Raw

LaraChan Logo

LaraChan

A simple 4chan-style imageboard built on Laravel.

  • 🧅 Tor - Built in Tor proxy
  • 🤖 CAPTCHA - Self-hosted captchas.
  • 🚫 No .JS - No front-end JavaScript.
  • 🖥 Laravel - Built on Laravel 8

Getting Started

LaraChan can be installed in 5 easy commands.

git clone [email protected]:anthonybudd/LaraChan.git

cd LaraChan

docker-compose up -d

php artisan larachan:install

php artisan serve

⚠️ Hint: MySQL might take a miniute or so to initalize on first boot

LaraChan Pi

Raspberry Pi Set-up

To set-up a Raspberry Pi server run the following commands.

git clone [email protected]:anthonybudd/LaraChan.git

cd LaraChan

mv docker-compose.arm64.yml docker-compose.yml

// TOR
git clone [email protected]:anthonybudd/nginx-tor-proxy.git && cd nginx-tor-proxy
docker run -ti --entrypoint="mkp224o" -v $(pwd):/tor larachan_larachan-tor-proxy -n 1 -S 10 -d /tor [FILTER] 
mv *.onion web
chmod 700 web
sed -ie 's#xxxxx.onion#'"$(cat web/hostname)"'#g' nginx/tor.conf
cat web/hostname
cd ..

docker-compose build

docker run -it --rm -v $(pwd):/app larachan_larachan composer install

docker-compose up

docker exec -it larachan php artisan larachan:install --platform=pi

Commands

LaraChan comes with some commands to make managing your imageboard easy.

$> larachan:populate

To populate your instance with fake data run the command php artisan larachan:populate

$> larachan:monitor

If you would like an automatically updating live view of all of the most popular threads on your imageboard use the command php artisan larachan:monitor {--threads=5} {--replies=5}

$> larachan:boards

List all the current boards php artisan larachan:boards

$> larachan:create-board

To create a new board run php artisan larachan:create-board {boardName} {boardTitle} {about?}

Example php artisan larachan:create-board pol "Politically Incorrect"

$> larachan:delete-board

To delete a board php artisan larachan:delete-board {boardName}

$> larachan:delete-thread

To delete a thread php artisan larachan:delete-thread {uuid}

$> larachan:delete-reply

To delete a reply php artisan larachan:delete-reply {uuid}

Todo

LaraChan is still in active development.

  • Admin Interface
  • IPFS integration
  • API
  • Tests
  • Fix validation - hacky solution atm, Validator::make()->validate() never returning an error bag? Probable session or Tor issue.