Syntax highlighting in README

This commit is contained in:
Pierre Rudloff 2016-07-27 13:40:18 +02:00
parent efe1a34a9f
commit bd02236ca5

View file

@ -14,25 +14,28 @@ You just have to unzip it on your server and it should be ready to use.
### From Git ### From Git
In order to get AllTube working, you need to use [npm](https://www.npmjs.com/) and [Composer](https://getcomposer.org/): In order to get AllTube working, you need to use [npm](https://www.npmjs.com/) and [Composer](https://getcomposer.org/):
```bash
npm install npm install
composer install composer install
```
This will download all the required dependencies. This will download all the required dependencies.
(Note that it will download the ffmpeg binary for 64-bits Linux. If you are on another platform, you might want to specify the path to avconv/ffmpeg in your config file.) (Note that it will download the ffmpeg binary for 64-bits Linux. If you are on another platform, you might want to specify the path to avconv/ffmpeg in your config file.)
You should also ensure that the *templates_c* folder has the right permissions: You should also ensure that the *templates_c* folder has the right permissions:
```bash
chmod 777 templates_c/ chmod 777 templates_c/
```
If your web server is Apache, you need to set the `AllowOverride` setting to `All` or `FileInfo`. If your web server is Apache, you need to set the `AllowOverride` setting to `All` or `FileInfo`.
## Config ## Config
If you want to use a custom config, you need to create a config file: If you want to use a custom config, you need to create a config file:
```bash
cp config.example.yml config.yml cp config.example.yml config.yml
```
## Web server configuration ## Web server configuration
### Apache ### Apache
@ -43,52 +46,52 @@ You will need the following modules:
### Nginx ### Nginx
Here is an exemple Nginx configuration: Here is an exemple Nginx configuration:
```nginx
server {
server_name localhost;
listen 443 ssl;
server { root /var/www/path/to/alltube;
server_name localhost; index index.php;
listen 443 ssl;
root /var/www/path/to/alltube; access_log /var/log/nginx/alltube.access.log;
index index.php; error_log /var/log/nginx/alltube.error.log;
access_log /var/log/nginx/alltube.access.log; types {
error_log /var/log/nginx/alltube.error.log; text/html html htm shtml;
text/css css;
text/xml xml;
application/x-web-app-manifest+json webapp;
}
types { # Deny access to dotfiles
text/html html htm shtml; location ~ /\. {
text/css css; deny all;
text/xml xml; }
application/x-web-app-manifest+json webapp;
}
# Deny access to dotfiles location / {
location ~ /\. { try_files $uri /index.php?$args;
deny all; }
}
location / { location ~ \.php$ {
try_files $uri /index.php?$args; try_files $uri /index.php?$args;
}
location ~ \.php$ { fastcgi_param PATH_INFO $fastcgi_path_info;
try_files $uri /index.php?$args; fastcgi_param PATH_TRANSLATED $document_root$fastcgi_path_info;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
fastcgi_param PATH_INFO $fastcgi_path_info; fastcgi_pass unix:/var/run/php5-fpm.sock;
fastcgi_param PATH_TRANSLATED $document_root$fastcgi_path_info; fastcgi_index index.php;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; fastcgi_split_path_info ^(.+\.php)(/.+)$;
fastcgi_intercept_errors off;
fastcgi_pass unix:/var/run/php5-fpm.sock; fastcgi_buffer_size 16k;
fastcgi_index index.php; fastcgi_buffers 4 16k;
fastcgi_split_path_info ^(.+\.php)(/.+)$;
fastcgi_intercept_errors off;
fastcgi_buffer_size 16k;
fastcgi_buffers 4 16k;
include fastcgi_params;
}
}
include fastcgi_params;
}
}
```
## License ## License
This software is available under the [GNU General Public License](http://www.gnu.org/licenses/gpl.html). This software is available under the [GNU General Public License](http://www.gnu.org/licenses/gpl.html).
@ -100,7 +103,7 @@ You need [avconv](https://libav.org/avconv.html), [rtmpdump](http://rtmpdump.mpl
If you don't want to enable conversions, you can disable it in *config.yml*. If you don't want to enable conversions, you can disable it in *config.yml*.
On Debian-based systems: On Debian-based systems:
```bash
sudo apt-get install libav-tools rtmpdump curl sudo apt-get install libav-tools rtmpdump curl
```
You also probably need to edit the *avconv* variable in *config.yml* so that it points to your ffmpeg/avconv binary (*/usr/bin/avconv* on Debian/Ubuntu). You also probably need to edit the *avconv* variable in *config.yml* so that it points to your ffmpeg/avconv binary (*/usr/bin/avconv* on Debian/Ubuntu).