Keyboard is a lightweight, really basic board software which features an invite-only (per generated keys) system and random anonymous nicknames in each thread (think 4chan ID's).
However, these things can easily be changed so it can be transformed into a traditional board.
Keyboard is written in Laravel 5.4
You can find most of the config in config/_custom.php
.
You can change pagination limits, add new callsigns and change groups or permissions.
A few notes about groups and permissions:
- The lowest group is always the one that stands for permanently banned (can't access the board at all).
- All groups under 0 may have restrictions (It is assumed that everything under 0 is not a full user).
- The highest group is always the one that gets assigned on use with your admin key.
If you want to remove the invite only access: Remove everything regarding keys in the register view and controller, as well as in the profile view and profile controller.
If you want to remove the anonymous callsigns: Simply change the $callnames[$xyz->author]
to $xyz->username
and remove the comments around ->username assignment in the thread controller.
The entire board is styled with bootstrap, so it's pretty easy to style over it. The css is found in public/css/
.
- Fork/Clone/Download this project
- Move the directory where you want to store it
- Rename
.env.example
to.env
and change your settings - Run
php artisan key:generate
- Run
php artisan migrate
Development
- Run
php artisan serve
Production
- Copy the contents of
public/
where you want to serve the url - Change the two bootstrap paths in
index.php
to the correct path - Make
storage/
writable withchmod -R o+w storage
- Get composer in your project root with
curl -s https://getcomposer.org/installer | php
- Run
php composer.phar install
- Run
php composer.phar dumpautoload -o
- Run
php artisan config:cache
- Run
php artisan route:cache
- Pull the newest version via git (make sure to backup your configs and changes you made)
- Run
php artisan migrate
- Run
php artisan config:cache
- Run
php artisan route:cache
- Copy the content of
public/
to your root if some of the files have changed