Documentation updates

This commit is contained in:
Alex Tselegidis 2020-09-29 14:21:38 +03:00
parent 4be7e798cd
commit fe6db931ea
3 changed files with 25 additions and 13 deletions

View File

@ -2,30 +2,42 @@
Plainpad is a web application that can be installed and run in web servers. Users will be able to reach the application
through their web browsers by using an active internet connection, just like visiting a normal website. The installation
process is very similar to the popular framework Laravel, so it is very likely that you will be familiar with the next
steps. Follow this article strictly in order to complete the installation with no problems.
process is very similar to the one required by the popular PHP framework Laravel, so it is very likely that you will be
familiar with the next steps. Follow this article strictly in order to complete the installation with no problems.
### Requirements
### Server Requirements
* Apache/NGINX
* PHP >= 7.2
* MySQL
* PHP >= 7.3
* BCMath PHP Extension
* Ctype PHP Extension
* Fileinfo PHP extension
* JSON PHP Extension
* Mbstring PHP Extension
* OpenSSL PHP Extension
* PDO PHP Extension
* Mbstring PHP Extension
* Zip PHP Extension
* Tokenizer PHP Extension
* XML PHP Extension
### Guide
### Steps
Plainpad requires a few steps and minimum configuration for the installation to your server.
1. Upload the contents of the zip archive to your server.
1. Make sure the web server points to the `public` directory.
1. Create a `.env` file based on the `.env.example` provided.
1. Run `php artisan migrate:fresh --seed` to setup the database.
1. Make sure the web server is configured to only serve the `public` directory.
1. Create an `.env` file based on the `.env.example` provided and enter your configuration values.
1. Run `php artisan migrate:fresh --seed` to set up the database.
Alternatively you can open the browser to the `/url/to/public/setup.php` file and submit the
installation form.
Make sure the application has writable permissions so that the auto update feature works smoothly.
Make sure the entire application directory is completely writable by the PHP process so that the auto update feature
works properly.
### Useful Links
* [Official Laravel Installation Guide](https://laravel.com/docs/8.x/installation)
* [Deploy Laravel To Shared Hosting](https://youtu.be/6g8G3YQtQt4)
[Back](readme.md)

View File

@ -4,6 +4,6 @@ Welcome to the documentation section of Plainpad.
* [Introduction](introduction.md)
* [Installation](installation.md)
* [Upgrading](upgrading.md)
* [Upgrade](upgrade.md)
* [Contributions](contributions.md)
* [API](api.md)

View File

@ -1,4 +1,4 @@
## Upgrading
## Upgrade
The self hosted version supports an automated updates that will notify admin users whenever new packages are available
for download.