From fa6cefa37cea650587396814311c45028d7bf402 Mon Sep 17 00:00:00 2001 From: Proxeus Date: Tue, 17 Nov 2020 02:35:10 +0100 Subject: [PATCH] Updated readme --- README.md | 35 +++++++++++++++++++++++++++++--- web/data/config/SQL/.trusted.php | 4 +--- 2 files changed, 33 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a1c517a..aa96bf3 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file diff --git a/web/data/config/SQL/.trusted.php b/web/data/config/SQL/.trusted.php index 133cbfd..c1ed9db 100644 --- a/web/data/config/SQL/.trusted.php +++ b/web/data/config/SQL/.trusted.php @@ -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" );