mirror/UNIT3D-Community-Edition
1
0
Fork 0
mirror of https://github.com/HDInnovations/UNIT3D-Community-Edition.git synced 2026-04-25 20:49:16 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
HDVinnie
2018-08-05 08:43:12 -04:00
committed by GitHub
parent a73ddd6b45
commit 4396db486e
1 changed files with 3 additions and 335 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -335
View File
@@ -10,7 +10,6 @@
<a href="http://laravel.com"><img src="https://img.shields.io/badge/Laravel-5.6.29-f4645f.svg" /></a> <a href="https://github.com/UNIT3D/UNIT3D/blob/master/LICENSE"><img src="https://img.shields.io/aur/license/yaourt.svg" /></a>
<a href="https://trello.com/b/tUDsQ0Gs/unit3d"><img src="https://img.shields.io/badge/Trello-HERE-green.svg" /></a>
<a class="badge-align" href="https://www.codacy.com/app/HDVinnie/UNIT3D?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=UNIT3D/UNIT3D&amp;utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/6c6c6c940aec420e987ea82adea272ee"/></a> <a href="https://discord.gg/Yk4NBUU"><img alt="Discord chat" src="https://cdn.rawgit.com/Hyleus/237f9903320939eb4f7615633a8fb221/raw/dca104edf34eabaca1016e633f06a52a346a7700/chat-Discord-blue.svg" /></a>
<a href="https://liberapay.com/HDVinnie/"><img src="https://img.shields.io/badge/liberapay-Support%20UNIT3D-yellow.svg"></a>
<a href="https://www.patreon.com/UNIT3D"><img src="https://img.shields.io/badge/patreon-Support%20UNIT3D-orange.svg"></a>
</p>
@@ -62,7 +61,7 @@ UNIT3D currently offers the following features:
- php-zip -> This is required for the Backup Manager.
- Crontab access
- A Redis server
- MySQL 5.7
- MySQL 5.7 + or MariaDB 10.2 +
- TheMovieDB API Key: https://www.themoviedb.org/documentation/api
- TheTVDB API Key: https://api.thetvdb.com/swagger
- OMDB API Key: http://www.omdbapi.com/
@@ -84,299 +83,8 @@ Traffic: Unlimited
Check it out here: https://github.com/ServNX/UNIT3D-INSTALLER
If you rather setup UNIT3D manually you can continue following the below instructions!
If you rather setup UNIT3D manually you can follow the instructions here: https://github.com/HDInnovations/UNIT3D/wiki/Manual-Install
Prerequisites Example:
1. ## Install OS
`Ubuntu Server 17.10 "Artful Aardvark" (64bits)`
or
`Ubuntu Server 16.04.4 LTS "Xenial Xerus" (64bits)`
2. ## Repositories
```
sudo add-apt-repository -y ppa:nginx/development
sudo add-apt-repository -y ppa:ondrej/php
sudo apt-get update
```
3. ## Required Software
#### Tools
```
sudo apt-get install -y git tmux vim curl wget zip unzip htop nano build-essential
```
#### Supervisor
```
sudo apt-get install supervisor
```
#### Redis
```
sudo apt-get install redis-server
```
#### Nginx
```
sudo apt-get install -y nginx
```
#### PHP
```
sudo apt-get install php-pear php7.2-curl php7.2-dev php7.2-gd php7.2-mbstring php7.2-zip php7.2-mysql php7.2-xml php7.2-fpm
```
#### NodeJS and NPM
```
curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
sudo apt-get install -y nodejs
```
#### Laravel Echo Server (for socket.io and broadcasting)
```
sudo npm install -g laravel-echo-server
```
4. ## Configure PHP
```
sudo nano /etc/php/7.2/fpm/php.ini
```
FIND
```
;cgi.fix_pathinfo=1
```
REPLACE WITH
```
cgi.fix_pathinfo=0
```
Save and close
Now restart php-fpm
```
sudo systemctl restart php7.2-fpm
```
5. ## Install MySQL
```
sudo apt-get install mysql-server
```
```
mysql_secure_installation
```
6. ## Configure Nginx
```
sudo nano /etc/nginx/sites-available/default
```
```
server {
listen 80 default_server;
root /var/www/html/public;
index index.html index.htm index.php;
server_name example.com;
location / {
try_files $uri $uri/ /index.php$is_args$args;
}
location ~ \.php$ {
include snippets/fastcgi-php.conf;
fastcgi_pass unix:/var/run/php/php7.2-fpm.sock;
}
}
```
Save and close.
Now restart nginx
```
sudo systemctl reload nginx
```
7. ## Secure Nginx with Let's Encrypt
https://www.digitalocean.com/community/tutorials/how-to-secure-nginx-with-let-s-encrypt-on-ubuntu-16-04
**Note:** If you are using `ufw` or any other firewall you will need to `allow` port `6001` for the next step.
With `ufw` you can do this simply by running:
```
sudo ufw allow 6001
```
8. ## Initialize Laravel Echo Server
Run:
```
laravel-echo-server init
```
The cli tool will help you setup a laravel-echo-server.json file in the root directory of your project.
This file will be loaded by the server during start up. You may edit this file later on to manage the configuration
of your server.
`? Do you want to run this server in development mode?` = `No` (Yes for debug or developement)
`? Which port would you like to serve from?` = `6001`
`? Which database would you like to use to store presence channel members?` = `redis`
`? Enter the host of your Laravel authentication server.` = `http://your-domain.tld`
`? Will you be serving on http or https?` = `http` or `https`
`? Do you want to generate a client ID/Key for HTTP API?` = `Yes`
`? Do you want to setup cross domain access to the API?` = `No`
#### You should see something like the following
```
appId: 73e82e6e1122cb58
key: 95eacbe008a722b247653afba0247c44
Configuration file saved. Run laravel-echo-server start to run server.
```
#### Note: DO NOT Run the start command !!!
The server should start automatically after loaded into Supervisor in the next section.
**Note:** If you are using SSL **(HTTPS)**, you will want to make sure that the certificate files are readable by
the user running the echo server.
For example if you are using `LetsEncrypt` for SSL, you may need to run a command like:
```
sudo chown www-data /etc/letsencrypt -R
```
9. ## Configure Supervisor
```
sudo nano /etc/supervisor/conf.d/unit3d.conf
```
Example:
```
[program:unit3d-queue]
process_name=%(program_name)s_%(process_num)02d
command=php /var/www/html/artisan queue:work --sleep=3 --tries=3
autostart=true
autorestart=true
user=www-data
numprocs=2
[program:unit3d-socket-io]
process_name=%(program_name)s_%(process_num)02d
command=/usr/bin/node /usr/bin/laravel-echo-server start --dir=/var/www/html
autostart=true
autorestart=true
user=www-data
numprocs=1
```
**Notes:**
`command=php /var/www/html ...` change this to the absolute path to the root of your site files where the `artisan`
file resides.
`user=www-data` you will probably want to change to something like your web server be it `apache` or `www-data`
`--dir=/var/www/html` change this to the absolute path to the root of your site files
Once this is done, save and close!
Next lets load new config and start the process.
Run:
```
sudo supervisorctl reread && supervisorctl update
```
Make sure there running and all is good!
Run:
```
sudo supervisorctl
```
If you see something like following your good to go!
```
unit3d-queue:unit3d-queue_00 RUNNING pid 12838, uptime 0:00:10
unit3d-queue:unit3d-queue_01 RUNNING pid 12833, uptime 0:00:10
unit3d-socket-io:unit3d-socket-io_00 BACKOFF Exited too quickly (process log may have details)
unit3d-socket-io:unit3d-socket-io_01 RUNNING pid 12828, uptime 0:00:10
```
**Note:** type `exit` at the prompt to exit supervisorctl
Main:
1. First grab the source-code and upload it to your web server. (If you have Git on your web server installed then clone it directly on your web server.)
2. Open a terminal and SSH into your server.
3. cd to the sites root directory
4. Run
```
sudo chown -R www-data: storage bootstrap public config && sudo find . -type d -exec chmod 0755 '{}' + -or -type f -exec chmod 0644 '{}' +
```
5. Run
```
php -r "readfile('http://getcomposer.org/installer');" | sudo php -- --install-dir=/usr/bin/ --filename=composer
```
6. Rename `.env.example` to `.env` and fill it with your APP, DB, REDIS and MAIL info.
7. Run
```
composer install && composer require predis/predis && npm install && npm install --save-dev socket.io-client && npm run dev
```
8. Edit `config/api-keys.php`, `config/app.php` and `config/other.php` (These house some basic settings. Be sure to visit the config manager from staff dashboard after up and running.)
9. Add `* * * * * php /path/to/artisan schedule:run >> /dev/null 2>&1` to crontab.
`/path/to/artisan` becomes whatever directory you put the codebase on your server.
Example `* * * * * php /var/www/html/artisan schedule:run >> /dev/null 2>&1`
10. Run
```
php artisan key:generate
```
11. Run
```
php artisan migrate --seed
```
12. Run
```
sudo chown -R www-data: storage bootstrap public config
```
13. Go to your sites URL.
14. Login with the username `UNIT3D` and the password `UNIT3D`.
**Note:** whatever you set in the `.env` if changed from defaults.
15. Enjoy using UNIT3D.
**Note:**
If you recieve a error during `npm install` regarding `pngquant-bin@4.0.0` OR an error similar to `... binary doesn't seem to work correctly` please run the following command
```
wget -q -O /tmp/libpng12.deb http://mirrors.kernel.org/ubuntu/pool/main/libp/libpng/libpng12-0_1.2.54-1ubuntu1_amd64.deb && sudo dpkg -i /tmp/libpng12.deb && rm /tmp/libpng12.deb && npm install && npm run dev
```
then try `npm install` again.
## <a name="packages"></a> Packages
Here are some packages that are built for UNIT3D.
- [An artisan package to import a XBTIT database into UNIT3D](https://github.com/pxgamer/xbtit-to-unit3d).
@@ -399,45 +107,7 @@ UNIT3D is open-sourced software licensed under the [GNU General Public License v
## <a name="homestead"></a> Homestead (for local developement)
<a href="https://laravel.com/docs/5.6/homestead#installation-and-setup">Install and Setup Homestead </a>
### Example `Homestead.yaml`
```yaml
folders:
- map: ~/projects
to: /home/vagrant/projects
sites:
...
- map: unit3d.site
to: /home/vagrant/projects/www/unit3d/public
databases:
- homestead
- unit3d
```
### Example `/etc/hosts`
```
127.0.0.1 localhost
127.0.1.1 3rdtech-gnome
...
192.168.10.10 unit3d.site
```
1. run `cd ~/Homestead && vagrant up --provision`
2. run `vagrant ssh`
3. cd to the unit3d project root directory
4. copy `.env.example` to `.env`
5. run `php artisan key:generate`
6. run `composer install`
7. run `npm install && npm run dev`
8. run `php artisan migrate:refresh --seed`
9. visit <a href="http://unit3d.site">unit3d.site</a>
10. Login u: `UNIT3D` p: `UNIT3D`
<hr>
For instructions on how to use Homestead for running UNIT3D in a local development environment check here: https://github.com/HDInnovations/UNIT3D/wiki/Homestead
## <a name="demo"></a> Demo
@@ -451,8 +121,6 @@ Password: UNIT3D
You can support my work if you are enjoying UNIT3D, this really keeps me up for fixing problems and adding new features. Also helps pay for the demo server + domain. Plus some beer to keep me sane. Some folks have asked me if it's possible to do a one-time donation, or if I accept cryptocurrency. Yes, and yes!
Liberapay: <a href="https://liberapay.com/HDVinnie/"><img src="https://img.shields.io/badge/liberapay-Support%20UNIT3D-yellow.svg"></a>
Patreon:<a href="https://www.patreon.com/UNIT3D"><img src="https://img.shields.io/badge/patreon-Support%20UNIT3D-orange.svg"></a>