root
/
threadr.lostcave.ddnss.de
3
1
Fork 1
Code Issues 18 Pull Requests Projects Releases Wiki Activity

updated documentation

master
BodgeMaster 2021-09-08 10:04:44 +02:00
parent 3e567a529e
commit 35fdf758c0
2 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -32,21 +32,18 @@ For now, the only way to set up an instance is doing it the manual way; automati
This setup guide is assuming that you are on a UNIX-like system and have the following already installed and set up properly: This setup guide is assuming that you are on a UNIX-like system and have the following already installed and set up properly:
- Apache with PHP (will most likely also work on other web servers) - Apache with PHP (will most likely also work on other web servers)
- MySQL or MariaDB - MySQL or MariaDB
- Python 2 (Will be changed to Python 3 soon. If Python 2 complains about shit, it's safe to assume that someone forgot to update this.) - Python 3
- Bash - Bash
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 `threadr/` to your desired location on the web root. - Symlink the directory `build/` to your desired location on the web root.
- Optionally symlink the file `default.html` to all places that you want to redirect to your ThreadR instance.
- 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.
- 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
WARNING: Currently, the configuration is permanent. It cannot be changed once the deployment script has been executed. This is a relic of our old deployment system and will change in the future.
Database tables: Database tables:
- boards - boards
- `id` (int, primary key, auto increment) - `id` (int, primary key, auto increment)
@ -103,18 +100,17 @@ TBD: Remove this section when the ThreadR project moves to its final home and th
## Symlinks ## Symlinks
The following files and directories are linked to areas where they can be accessed by the web server: The following files and directories are linked to areas where they can be accessed by the web server:
* `threadr/` → `threadr.lostcave.ddnss.de/threadr/` (all files acessible by the web server, READMEs get deleted on deployment) * `build/` → `threadr.lostcave.ddnss.de/` (all files acessible by the web server, READMEs get deleted on deployment)
* `default.html` → `threadr.lostcave.ddnss.de/index.html` (http redirect)
# Individual documentation for each file # Individual documentation for each file
### [[DIR] threadr](./threadr) ### [[DIR] src](./src)
This folder contains all the files that are parts of ThreadR directly This folder contains all the files that are parts of ThreadR directly
### [[DIR] build](./build)
Placeholder folder to link against, will be deleted and recreated by the deployment script, contains the a working instance of ThreadR after successful execution of the deployment script
### [[DIR] config](./config) ### [[DIR] config](./config)
A place to store the configuation for a specific ThreadR instance (contains official instance config for now, will be moved elsewhere eventually) A place to store the configuation for a specific ThreadR instance (contains official instance config for now, will be moved elsewhere eventually)
### [[DIR] macros](./macros) ### [[DIR] macros](./macros)
files for use with variable_grabbler.py files for use with variable_grabbler.py
### [default.html](./default.html)
The main index.html on the server. It redirects to ThreadR.
### [deployment_script.sh](./deployment_script.sh) ### [deployment_script.sh](./deployment_script.sh)
This script is executed each time (or most of the time) the repository gets pushed. This script is executed each time (or most of the time) the repository gets pushed.
It contains the commands to execute the code variable replcement system and some other useful tasks. It contains the commands to execute the code variable replcement system and some other useful tasks.

5
build/README.md
View File

@ -1 +1,6 @@
# Placeholder
This directory is here as a placeholder for the build process. This directory is here as a placeholder for the build process.
# Files
### [README.md](./README.md)
this file