Installation - Link Shortner

Requirements

• VPS or dedicated server running Linux (our guides use and recommend Ubuntu)
• A domain name (like www.example.com)
• Discord account

1. Server Setup

To allow Link Shortener to run, the required software needs to be present on the server. This software includes; Nginx (web-server), MySQL (database) and, Node.js with NPM.

If this software is not installed, our LEMN Stack Install guide can be followed for the installation of these components.

2. File Upload

By downloading and uploading the files to a server, the database can be set up in step three and the application can be started later on. The files are required.

Download the latest version of Link Shortener from the Project Phil website.

1. Download and extract the contents of the RAR file to your computer.
2. Upload the Link Shortener folder to the server, for example: /home/Link-Shortener
   • This should mean that the index is located at /home/Link-Shortener/index.js

3. Configure Link Shortener

Before starting Link Shortener, you need to configure the config.js file.

Open the configuration file:

nano /home/Link-Shortener/config.js

Fill out the required information in the config.js file.

Once you have filled out all the required information, save the file and continue with the installation steps below.

4. Install Link Shortener

Change to the Link Shortener directory:

cd /home/Link-Shortener

Install the required Node.js packages:

npm install

Once the installation is complete, run the database migrations:

npm run setup

Once the migration has completed successfully, continue to the next step.

5. Start Link Shortener

To start Link Shortener we recommend a Screen Session is used to ensure the application continues to operate once the terminal is closed. To start Link Shortener use the node command.

node .