Installation Guide: Difference between revisions
No edit summary |
|||
| Line 42: | Line 42: | ||
After installing apache, a simple config like this will work well. This should be located within your /etc/apache2/sites-available directory (this is in /etc/httpd/sites-available for centos or fedora): | After installing apache, a simple config like this will work well. This should be located within your /etc/apache2/sites-available directory (this is in /etc/httpd/sites-available for centos or fedora): | ||
< | <pre> | ||
<VirtualHost *:80> | <VirtualHost *:80> | ||
ServerName example.com | ServerName example.com | ||
| Line 57: | Line 57: | ||
CustomLog ${APACHE_LOG_DIR}/access.log combined | CustomLog ${APACHE_LOG_DIR}/access.log combined | ||
</VirtualHost> | </VirtualHost> | ||
</ | </pre> | ||
The following site config disables directory listing. Then utilize <code>a2ensite yoursiteconfig</code> and reload apache to start your website. | The following site config disables directory listing. Then utilize <code>a2ensite yoursiteconfig</code> and reload apache to start your website. | ||
===Nginx=== | ===Nginx=== | ||
== Cloudflare == | == Cloudflare == | ||
== MySQL == | == MySQL == | ||
Revision as of 17:11, 11 March 2024
This page covers how to install vichan.
Base Requirements
- PHP >= 7.4
- MySQL/MariaDB server
- mbstring
- PHP GD
- PHP PDO
- PHP BCMath
- Composer
- A Unix-like OS
We try to make sure vichan is compatible with all major web servers. vichan does not include an Apache `.htaccess` file nor does it need one.
Recommended
- MySQL/MariaDB server >= 5.5.3
- ImageMagick (command-line ImageMagick or GraphicsMagick preferred).
- APCu (Alternative PHP Cache), Memcached or Redis
- Gifsicle
If you have zero experience running a website, landchad.net has a nice guide on how to set up a web server. Ubuntu is by far the easiest OS to use to set up any server.
Downloading Vichan
It is recommended that you utilize git clone to install vichan. This will install the latest version of the software.
Make sure you have navigated in your terminal to whichever directory your webserver is in (commonly /var/www/), or cd /var/www/.
Then clone the repository by entering git clone https://github.com/vichan-devel/vichan.git FolderName (with FolderName being optional). You may need to install git first.
After this finishes, if you did not specify a destination folder you may opt to move the resulting folder (named vichan) to something else (mv vichan NewFolderName).
Next, enter your vichan folder (cd vichan) and run composer (composer install).
- If you do not have all needed dependencies installed, composer may fail, in which case it will tell you what is needed.
Configuring the Web server
Vichan does not require much of a modified configuration to work.
If you are on the fence on which server to use, Nginx is more commonly used and is notably faster on larger websites. Apache, on the other hand, works more "out of the box" and may be easier to understand if less experienced with running a server. Both servers work well with vichan.
Apache
After installing apache, a simple config like this will work well. This should be located within your /etc/apache2/sites-available directory (this is in /etc/httpd/sites-available for centos or fedora):
<VirtualHost *:80>
ServerName example.com
ServerAlias www.example.com # Optional
<Directory /var/www/YourVichanFolder>
Options -Indexes +FollowSymLinks
AllowOverride All
Require all granted
</Directory>
ServerAdmin webmaster@localhost
DocumentRoot /var/www/YourVichanFolder
ErrorLog ${APACHE_LOG_DIR}/error.log
CustomLog ${APACHE_LOG_DIR}/access.log combined
</VirtualHost>
The following site config disables directory listing. Then utilize a2ensite yoursiteconfig and reload apache to start your website.
