fix documentation

master
BodgeMaster 2021-09-08 10:39:00 +02:00
parent a3d60795d8
commit 7b2295be94
3 changed files with 14 additions and 1 deletions

View File

@ -38,11 +38,12 @@ This setup guide is assuming that you are on a UNIX-like system and have the fol
Installation: Installation:
- To install the ThreadR Forum Engine, clone this repository into a directory that the web server has access to but that it outside of any web root. - To install the ThreadR Forum Engine, clone this repository into a directory that the web server has access to but that it outside of any web root.
- Symlink the directory `build/` to your desired location on the web root.
- Add a database to your MySQL/MariaDB server that contains the tables shown below. - Add a database to your MySQL/MariaDB server that contains the tables shown below.
- Create a MySQL/MariaDB user for ThreadR and grant usage privileges for the tables to it. - Create a MySQL/MariaDB user for ThreadR and grant usage privileges for the tables to it.
- Symlink the directory `build/` to your desired location on the web root. ThreadR does not support being linked directly to the webroot.
- adjust the files in `config/` to your setup - adjust the files in `config/` to your setup
- run ./deployment-script.sh to apply configuration - run ./deployment-script.sh to apply configuration
- Optionally symlink `build/redirect_home.html` to all places that you want to redirect to ThreadR.
Database tables: Database tables:
- boards - boards

View File

@ -29,3 +29,5 @@ the homepage
this file this file
### [style.css](./style.css) ### [style.css](./style.css)
the stylesheet used on every ThreadR site the stylesheet used on every ThreadR site
### [redirect_home.html](./redirect_home.html)
small HTML file that redirects to ThreadR, can be linked or copied to any place that needs to redirect to ThreadRs landing page

10
src/redirect_home.html Normal file
View File

@ -0,0 +1,10 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="refresh" content="0;%CONTENT_DIR%/" />
</head>
<body>
<p> Your browser seems to not support redirects. <br />
Please klick the following link to continue: <a href="%CONTENT_DIR%/"> Go to home page... </a></p>
</body>
</html>