2 ‐ Installation Guide - Ubivis/bookcreator GitHub Wiki
This guide covers the installation process for the Markdown to PDF Book Generator. The tool can be installed on any server with PHP 7.4 or higher.
- PHP 7.4 or higher
- Composer
- Web server with PHP support (Apache, Nginx, etc.)
- 128MB+ of memory allocated to PHP
- Write permissions for the output directory
- GD or Imagick extension for image processing
Clone the repository using Git:
git clone https://github.com/Ubivis/bookcreator.git
cd bookcreator
Alternatively, download the ZIP file from GitHub and extract it to your web server directory.
Use Composer to install the required dependencies:
composer install
For production environments, use:
composer install --no-dev --optimize-autoloader
Create a directory for the generated PDFs and set the appropriate permissions:
mkdir -p output
chmod 755 output
Configure your web server to point to the directory. For example, with Apache, you might need a .htaccess
file with:
<IfModule mod_rewrite.c>
RewriteEngine On
RewriteBase /
RewriteRule ^index\.php$ - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule . /index.php [L]
</IfModule>
Upload all the files to your hosting account via FTP or the hosting control panel.
Some hosting providers offer Composer through their control panel. If not, you can:
- Install Composer locally on your machine
- Run
composer install
locally - Upload the vendor directory to your server
Make sure the output
directory has write permissions:
chmod 755 output
In Plesk:
- Go to Domains > example.com > Subdomains
- Create a new subdomain (e.g.,
book.example.com
) - Set the document root to where you'll upload the files
Upload the files to the subdomain's directory using FTP or Plesk's File Manager.
Using SSH access:
cd /var/www/vhosts/example.com/book.example.com
composer install --no-dev --optimize-autoloader
Alternatively, if your Plesk has the Composer extension:
- Go to Tools & Settings > Composer
- Navigate to your subdomain directory
- Click "Install Dependencies"
mkdir -p output
chmod 755 output
You may need to adjust your PHP settings for optimal performance, especially for large books:
memory_limit = 128M
max_execution_time = 120
post_max_size = 16M
upload_max_filesize = 16M
These settings can be adjusted in:
- PHP.ini file
- .htaccess file (if using Apache)
- Through your hosting control panel
To verify the installation:
- Navigate to the URL where you installed the generator
- You should see the web interface with tabs for file upload and GitHub integration
- Try a simple test by uploading a small Markdown file
If you see the interface and can generate a PDF, the installation was successful!
Now that you've installed the generator, head over to the [Usage Guide](Usage-Guide) to learn how to use it to create your first PDF book.