extern/enigma-bbs
1
0
Fork 0
mirror of https://gitlab.com/enigmatico/enigma-bbs.git synced 2024-10-04 17:21:58 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated readme

Browse Source
This commit is contained in:
Proxeus 2020-11-17 02:35:10 +01:00
parent 4597e9fa26
commit fa6cefa37c
2 changed files with 33 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -2,9 +2,38 @@
# enigma-bbs
## Some kind of bulletin board system written in PHP
This is a personal project for a simple text-only bulletin board engine. It's currently on the works and it still doesn't work properly,
plus it lacks of some basic features. For now, it doesn't even have basic features such as moderation or a control panel, so everything
has to be done manually by hand in the data base.
## Requirements
· A web server (Apache, nginx...)
· PHP 7+ (Something that has the mysqli extension)
· MySQL (Tested with version 8 but should work with earlier versions)
· Patience
## Installation
1. Open data/config/.config.php with your text editor.
2. Change the value of each option accordingly.
3. Open data/config/SQL/.trusted.php
4. In trusted_locations, add your machine IP address to the list (if you are installing from a remote machine)
5. Upload the whole content of the web folder to your web server (wherever you are installing it)
6. From your web browser, load the install.php script
__To make your site functional, you'll have to manually configure your site by editing the database. I recommend having phpmyadmin for this.__
1. Add a new row to the sm_config table in your database with the name of your site, the description, some MOTD in the news, and set
the default_stile column to solarized.css (The only available style as of now).
2. Add some categories to the sm_board_category table. You only need to insert the name. Take note of the IDs.
3. Now create some boards by inserting some rows to the sm_boards table. The PREFIX column is just a prefix. Set the CATEGORY to the ID of the
corresponding category in sm_board_category.
In order to set up the headers for each board, you also need to create a new folder in static/banners. The name of the folder will be the ID
of the board. Inside of each folder you can add as many images as you want (recommended size 1024x200 for eahc), the script will choose a random one.
__That's it!! You're finally ready.__
![Project Overview](/docs/res/overview.png)
This is a personal project for a simple text-only bulletin board engine. It's currently on the works and it still doesn't work properly,
plus it lacks of some basic features.

4
web/data/config/SQL/.trusted.php
View File

@ -5,9 +5,7 @@
$trusted_locations = array(
"127.0.0.1",
"::1",
"localhost",
"192.168.1.180",
"192.168.1.150"//,
"localhost"
//"Anotherhost",
//"192.168.1.30"
);