Skip to content
Permalink
Browse files

Configuration and a bit of documentation update

  • Loading branch information...
OtakuMegane committed Apr 29, 2019
1 parent f347cdf commit 0d7ed916333e848e2c392f1fc78ac3551ddbf0c3
Showing with 12 additions and 18 deletions.
  1. +1 −1 README.md
  2. +0 −2 board_files/include/initializations.php
  3. +3 −9 configuration/config.php.example
  4. +8 −6 documentation/DEV-GUIDE.md
@@ -2,7 +2,7 @@
## About
A relatively lightweight, expandable and highly configurable imageboard written in PHP. Nelliel was originally a modified version of [Futallaby](https://www.1chan.net/futallaby/) made to host Nigrachan. The software had good potential and was split off to independent development. The codebase has since been fully rewritten and expanded, with continuing refinements. It does not try to do everything imaginable but instead provides a solid core that is readily expandable for users with additional needs.

**At present Nelliel should be considered beta software. Use with caution. It is still incomplete and will have breaking changes.**
**At present Nelliel is in a beta stage of development. Use with caution. It is still incomplete and probably has a lot of bugs.**

## Minimum Requirements
These are only the confirmed bare minimum requirements for Nelliel to function. Earlier versions may work but are likely to be unstable and will not receive any support. **It is strongly recommended to use the latest software versions available.**
@@ -76,7 +76,6 @@
$base_config['defaultadmin'] = '';
$base_config['defaultadmin_pass'] = '';
$base_config['tripcode_pepper'] = 'sodiumz';
$base_config['run_setup_check'] = true;
$base_config['directory_perm'] = '0775';
$base_config['file_perm'] = '0664';
$base_config['use_internal_cache'] = true;
@@ -93,7 +92,6 @@
define('DEFAULTADMIN', $base_config['defaultadmin']);
define('DEFAULTADMIN_PASS', $base_config['defaultadmin_pass']);
define('RUN_SETUP_CHECK', (bool)$base_config['run_setup_check']);
define('DIRECTORY_PERM', $base_config['directory_perm']);
define('FILE_PERM', $base_config['file_perm']);
define('USE_INTERNAL_CACHE', $base_config['use_internal_cache']);
@@ -27,6 +27,9 @@ $base_config['defaultadmin_pass'] = '';
// The available locales and their translations can be found in the directory 'board_files/language/locale'
$base_config['default_locale'] = 'en_US';

// Forces Nelliel to only allow sessions over a secure connection.
// Once SSL set up for the site, it is recommended you set this to true.
$base_config['secure_session_only'] = false;

//
// === Database Access Settings ===
@@ -129,10 +132,6 @@ $db_config['sqlite_encoding'] = 'UTF-8';

// In most cases you won't need to mess with this stuff.

// Each time the script is run, this goes through the setup sequence and checks that everything is in place.
// Once initial setup and testing is finished this isn't really necessary and can be set to false.
$base_config['run_setup_check'] = true;

// Default file and directory permissions. Format must be in the proper octal format.
$base_config['directory_perm'] = '0775';
$base_config['file_perm'] = '0664';
@@ -145,14 +144,9 @@ $base_config['use_internal_cache'] = true;
// Enable or disable plugins
$base_config['enable_plugins'] = true;

// Forces Nelliel to only use sessions over a secure connection.
// Once SSL set up for the site, it is recommended you set this to true.
$base_config['secure_session_only'] = false;

// Enable/disable template caching for Mustache.
$base_config['use_mustache_cache'] = true;


//
// === Crypt Settings ===
//
@@ -2,7 +2,7 @@

A guide to the development standards of Nelliel. Any contributions to the core codebase or official plugins must follow these guidelines. Pull requests not adhering to the guidelines must be fixed before acceptance.

Developers of mods, plugins or other unofficial contributions are not required to follow this guide.
Developers of plugins or other unofficial contributions are not required to follow this guide.

## Coding Style and Formatting
Nelliel follows the [PSR-1](http://www.php-fig.org/psr/psr-1/) and [PSR-4](http://www.php-fig.org/psr/psr-4/) standards.
@@ -19,10 +19,10 @@ In addition:
- Procedural is not evil. OOP is not the Holy Grail. Use what makes sense for a given situation.
- Function names should be prefixed with `nel_`
- Classes should be within the `Nelliel` namespace.
- If a class instance or mutable variable needs to be accessible in a global scope it should be encapsulated inside a function.
- If a class instance or mutable variable needs to be accessible in a global scope it must be encapsulated inside a function.

## SQL and Queries
All schemas should comply with ANSI standards. In cases where a data type is not fully cross-compatible or has a differing name (e.g. the BINARY equivalent in PostgreSQL is BYTEA), an equivalent may be used for the specific RDBMS schema; however the behavior should be indistinguishable.
All schemas should comply with ANSI standards. In cases where a data type is not fully cross-compatible or has a differing name (e.g. the BINARY equivalent in PostgreSQL is BYTEA), an equivalent may be used for the specific RDBMS schema so long as the behavior is indistinguishable.

Query requirements:
- Queries must be done through PDO or a PDO-extending class such as NellielPDO.
@@ -34,7 +34,7 @@ Query requirements:
- Database NULL should be treated as unknown value.

## Targets and Version Support
Any stable core functions and features contributed to Nelliel must be fully functional with the minimum versions listed below in addition to all later versions of the software. These minimum requirements will change over time due to certain circumstances including (but not limited to):
Any core functions and features contributed to Nelliel must be fully functional with the minimum versions listed below in addition to all later versions of the software. These minimum requirements will change over time due to certain circumstances including (but not limited to):
- Usage of the minimum version becomes negligible.
- A necessary feature or function cannot be reasonably implemented.
- Forward compatibility becomes impractical.
@@ -45,7 +45,7 @@ At present Nelliel has a target version of **PHP 7.0**.
### Database Support
Minimum supported RDBMS versions:
- MySQL 5.6
- MariaDB 10.0
- MariaDB 10
- PostgreSQL 9.4
- SQLite 3.16

@@ -54,6 +54,8 @@ These are the minimum browser versions Nelliel must be compatible with:
- Safari 11
- Chrome 64
- Firefox 56

Retaining compatibility with older browsers when feasible is encouraged but not mandatory.

## Versioning
Upon the initial 1.0 Release, Nelliel versioning will follow Major.Minor.Patch under these definitions:
@@ -65,7 +67,7 @@ When the version changes, the constant `NELLIEL_VERSION` in file `imgboard.php`

## Error Codes
Nelliel returns a numeric error id along with an error message. This keeps the better user experience without making it difficult to track exactly where in the code things went wrong (especially when other translations are involved). These are the designated ranges:
- 0: Unknown or nonspecific error. Very rare.
- 0: Unknown or nonspecific error.
- 1-99: Content-related errors (upload problems, duplicate files, etc.).
- 100-199: General system and input errors.
- 200-299: Management-related system and input errors.

0 comments on commit 0d7ed91

Please sign in to comment.
You can’t perform that action at this time.