carc1n0gen/weelnk

Small self hostable link shortening service written in PHP with the slim micro framework

Installs: 12

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 1

Type:project

v2.2.1 2018-09-14 15:43 UTC

This package is not auto-updated.

Last update: 2020-09-19 06:09:45 UTC


README

Build Status Coverage Status License: MIT

A small self hostable link shortening service writting in PHP with the Slim micro framework

Screenshot

Install

git clone https://github.com/carc1n0gen/weelnk.git path/to/install && cd path/to/install

The master branch should always be stable, but it is recommended to checkout the latest tagged release. Check out the release page for the latest updates, and upgrade/migrations guides.

git checkout v2.2.0

Then install the dependencies

composer install

Environment Variables

For development it's good enough to just copy the example .env file and modify it as needed

cp .env.example .env

In production you should set real environment variables for the process. The .env.example contains the required variables.

Database Setup

Run the database migrations to create the database schema

vendor/bin/doctrine-migrations migrations:migrate

Permissions

The storage directory will need write permissions for the web server.

Ubuntu/Debian: sudo chown -R www-data:www-data storage

FreeBSD: sudo chown -R www:www storage

Upgrading

Take a look at the releases page to see the latest releases. You can also subscribe to that page as an rss feed, as it's url doubles as a feed. Each release will contain the release notes and other information like if migrations are required.

v2.1.0 And Above

We now have an upgrade script that will take care of everything.

php upgrade.php [version number]

This command will fetch the latest changes, checkout the version specified, and run migrations.

Make sure you include the v in the version number.

The Old way

git fetch --tags && git checkout [version-number] - This will fetch the updates and then switch to the version number you specified. Make sure you replace [version-number] with the version number you want to upgrade to, including the letter v

composer install - To install new dependencies in case there were any

vendor/bin/doctrine-migrations migrations:migrate - Runs database migrations in case any are needed. This is safe to run regardless of if there are migrations or not.

License

Weelnk is open-sourced software licensed under the MIT license.