zydronium/enigma-bbs
1
0
Fork 0
mirror of https://github.com/NuSkooler/enigma-bbs.git synced 2025-08-03 08:22:02 +02:00
Code Issues Projects Releases Packages Wiki Activity

* Docs theme to match ENiGMA website

Browse source 
* New docs layout ready for github pages serving
* Tonnes of new docs
* Update gitignore
* Probably other stuff too
This commit is contained in:
David Stephens 2018-01-31 23:35:54 +00:00
parent 06ea2d1600
commit 26849ba4fa
62 changed files with 1974 additions and 810 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/configuration/directory-structure.md Normal file
View file

@ -0,0 +1,20 @@
---
layout: page
title: Directory Structure
---
All paths mentioned here are relative to the ENiGMA½ checkout directory.
| Directory | Description |
|---------------------|-----------------------------------------------------------------------------------------------------------|
| `/art/general` | Non-theme art - welcome ANSI, logoff ANSI, etc. See [General Art](/art/general).
| `/art/themes` | Theme art. Themes should be in their own subdirectory and contain a theme.hjson. See [Themes](/art/themes).
| `/config` | config.hjson, [menu.hjson](/configuration/menu-hjson) and prompt.hjson storage. Also default path for SSL certs and public/private keys
| `/db` | All ENiGMA½ databases in Sqlite3 format
| `/docs` | These docs ;-)
| `/dropfiles` | Dropfiles created for [local doors](/modding/local-doors)
| `/logs` | Logs. See [Monitoring Logs](/troubleshooting/monitoring-logs)
| `/misc` | Stuff with no other home; reset password templates, common password lists, other random bits
| `/mods` | User mods. See [Modding](/modding/existing-mods)
| `/node_modules` | External libraries required by ENiGMA½, installed when you run `npm install`
| `/util` | Various tools used in running/debugging ENiGMA½
| `/www` | ENiGMA½'s built in webserver root directory