docs
This commit is contained in:
Sergio Brighenti
parent
97bec212dc
commit
5a98e6f6a6
|
|
@ -3,17 +3,17 @@ layout: default
|
|||
title: Configuration
|
||||
nav_order: 3
|
||||
---
|
||||
# Platform Configuration
|
||||
# Configuration
|
||||
|
||||
## Web Server Configuration
|
||||
## Web Server
|
||||
*Apache need the `mod_rewrite` extension to make XBackBone work properly*.
|
||||
|
||||
If you do not use Apache, or the Apache `.htaccess` is not enabled, set your web server so that the `static/` folder is the only one accessible from the outside, otherwise even private uploads and logs will be accessible!
|
||||
|
||||
You can find an example configuration [`nginx.conf`](https://github.com/SergiX44/XBackBone/blob/master/nginx.conf) in the project repository.
|
||||
If you are using NGINX, you can find an example configuration [`nginx.conf`](https://github.com/SergiX44/XBackBone/blob/master/nginx.conf) in the project repository.
|
||||
|
||||
## Maintenance Mode
|
||||
Maintenance mode is automatically enabled during an upgrade using the upgrade manager. You can activate it manually by adding in the configuration file this:
|
||||
Maintenance mode is automatically enabled during an upgrade using the upgrade manager. You can activate it manually by editing the `config.php`, and adding this line:
|
||||
|
||||
```php
|
||||
return array(
|
||||
|
|
@ -22,8 +22,26 @@ return array(
|
|||
);
|
||||
```
|
||||
|
||||
## Database support
|
||||
|
||||
## Enable LDAP Authentication
|
||||
Currently, is supported `MySQL/MariaDB` and `SQLite3`.
|
||||
|
||||
For big installations, `MySQL/MariaDB` is recommended.
|
||||
|
||||
Example config:
|
||||
```php
|
||||
return array(
|
||||
...,
|
||||
'db' => array (
|
||||
'connection' => 'mysql', // sqlite or mysql
|
||||
'dsn' => 'host=localhost;port=3306;dbname=xbackbone', // the path to db, if sqlite
|
||||
'username' => 'xbackbone', // null, if sqlite
|
||||
'password' => 's3cr3t', // null, if sqlite
|
||||
),
|
||||
)
|
||||
```
|
||||
|
||||
## LDAP Authentication
|
||||
|
||||
Since the release 3.1, the LDAP integration can be configured.
|
||||
|
||||
|
|
@ -41,7 +59,79 @@ return array(
|
|||
);
|
||||
```
|
||||
|
||||
By activating this function, it will not be possible for users logging in via ldap to reset the password from the application (for obvious reasons), and it will also be possible to bring existing users under LDAP authentication.
|
||||
By activating this function, it will not be possible for users logging in via LDAP to reset the password from the application (for obvious reasons), and it will also be possible to bring existing users under LDAP authentication.
|
||||
|
||||
|
||||
## Storage drivers
|
||||
|
||||
XBackBone supports these storage drivers (with some configuration examples):
|
||||
|
||||
+ Local Storage (default)
|
||||
```php
|
||||
return array(
|
||||
...
|
||||
'storage' => array (
|
||||
'driver' => 'local',
|
||||
'path' => '/path/to/storage/folder',
|
||||
)
|
||||
);
|
||||
```
|
||||
|
||||
+ Amazon S3
|
||||
```php
|
||||
return array(
|
||||
...
|
||||
'storage' => array (
|
||||
'driver' => 's3',
|
||||
'key' => 'the-key',
|
||||
'secret' => 'the-secret',
|
||||
'region' => 'the-region',
|
||||
'bucket' => 'bucket-name',
|
||||
'path' => 'optional/path/prefix',
|
||||
)
|
||||
);
|
||||
```
|
||||
|
||||
+ Dropbox
|
||||
```php
|
||||
return array(
|
||||
...
|
||||
'storage' => array (
|
||||
'driver' => 'dropbox',
|
||||
'token' => 'the-token',
|
||||
)
|
||||
);
|
||||
```
|
||||
|
||||
+ FTP(s)
|
||||
```php
|
||||
return array(
|
||||
...
|
||||
'storage' => array (
|
||||
'driver' => 'ftp',
|
||||
'host' => 'ftp.example.com',
|
||||
'port' => 21,
|
||||
'username' => 'the-username',
|
||||
'password' => 'the-password',
|
||||
'path' => 'the/prefix/path/',
|
||||
'passive' => true/false,
|
||||
'ssl' => true/false,
|
||||
)
|
||||
);
|
||||
```
|
||||
|
||||
+ Google Cloud Storage
|
||||
```php
|
||||
return array(
|
||||
...
|
||||
'storage' => array (
|
||||
'driver' => 'google-client',
|
||||
'project_id' => 'the-project-id',
|
||||
'key_path' => 'the-key-path',
|
||||
'bucket' => 'bucket-name',
|
||||
)
|
||||
);
|
||||
```
|
||||
|
||||
## Change app install name
|
||||
Add to the `config.php` file an array element like this:
|
||||
|
|
|
|||
21
docs/license.md
Normal file
21
docs/license.md
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
---
|
||||
layout: default
|
||||
title: License & Credits
|
||||
nav_order: 7
|
||||
---
|
||||
|
||||
## License
|
||||
This software is licensed under the <a href="https://choosealicense.com/licenses/agpl-3.0/">GNU Affero General Public License v3.0</a>, available in this repository.
|
||||
As a "copyright notice" it is sufficient to keep the small footer at the bottom of the page, also to help other people to learn about this project!
|
||||
|
||||
## Built with
|
||||
+ Project logo by [@Sere](https://www.deviantart.com/serenaitalia)
|
||||
+ Slim 3 since `v2.0`, and Slim 4 since `v3.0` (https://www.slimframework.com/) and some great PHP packages (Flysystem, Intervention Image, Twig, etc)
|
||||
+ FlightPHP, up to `v1.x` (http://flightphp.com/)
|
||||
+ Bootstrap 4 (https://getbootstrap.com/)
|
||||
+ Font Awesome 5 (http://fontawesome.com)
|
||||
+ ClipboardJS (https://clipboardjs.com/)
|
||||
+ HighlightJS (https://highlightjs.org/)
|
||||
+ JQuery (https://jquery.com/)
|
||||
+ Plyr.io (https://plyr.io/)
|
||||
+ Dropzone.js (https://www.dropzonejs.com/)
|
||||
|
|
@ -5,16 +5,23 @@ nav_order: 4
|
|||
---
|
||||
|
||||
# How to update
|
||||
##Self-update (since v2.5):
|
||||
+ Navigate to the system page as admin.
|
||||
|
||||
The system updates can be applied via the web interface by an administrator, or manually via CLI.
|
||||
|
||||
## Self-update (since v2.5)
|
||||
+ Navigate to the system page as administrator.
|
||||
+ Click the check for update button, and finally the upgrade button.
|
||||
+ Wait until the browser redirect to the install page.
|
||||
+ Click the update button.
|
||||
+ Done.
|
||||
|
||||
|
||||
## Manual update:
|
||||
## Manual update
|
||||
+ Download and extract the release zip to your document root, overwriting any file.
|
||||
+ Navigate to the `/install` path (es: `http://example.com/` -> `http://example.com/install/`)
|
||||
+ Click the update button.
|
||||
+ Done.
|
||||
+ Done.
|
||||
|
||||
### Pre-release channel
|
||||
|
||||
From the system page, you can also choose to check from beta/RC releases, these are NOT considered stable enough for every day use, but only for testing purposes, **take a backup before upgrading to these versions**.
|
||||
Loading…
Reference in a new issue