1
0
mirror of https://github.com/cydrobolt/polr.git synced 2024-07-15 07:49:11 +02:00
Go to file
2023-09-17 12:22:58 -04:00
.github Update ISSUE_TEMPLATE.md 2018-02-15 14:55:46 -05:00
app Merge pull request from GHSA-vg6w-8w9v-xxqc 2021-01-28 17:40:44 -05:00
bootstrap Use ApiException to handle API errors and use ApiMiddleware to handle API authentication 2017-03-17 17:00:13 -04:00
config Fix missing Maxmind license key issue (#566) 2020-10-06 14:18:26 -04:00
database create api quota index 2017-12-21 08:44:24 -02:00
docs Fix missing Maxmind license key issue (#566) 2020-10-06 14:18:26 -04:00
public Delete about.js 2020-12-07 03:56:54 -05:00
resources Update about.blade.php (#579) 2020-12-16 21:34:33 -05:00
storage 2.0 init commit 2015-11-02 23:13:32 -05:00
tests Add option to redirect 404s and disabled URLs; update setup picture for 2.0.0 stable 2016-09-11 16:01:34 -04:00
util Bump version to 2.2.0; fix versioning script 2017-05-06 20:35:46 -04:00
.env.setup Bump version for 2.3.0 2021-02-09 01:04:31 -05:00
.gitignore Do not track vendor dir 2016-10-30 16:55:32 +00:00
.jshintrc delegate button actions to parent & add API active toggle logic 2015-12-12 12:47:20 -05:00
.readthedocs.yaml Update .readthedocs.yaml 2023-09-17 12:22:58 -04:00
.travis.yml Install dependencies thorugh composer on CI 2016-02-27 16:11:51 -05:00
artisan 2.0 init commit 2015-11-02 23:13:32 -05:00
composer.json Merge pull request from GHSA-vg6w-8w9v-xxqc 2021-01-28 17:40:44 -05:00
composer.lock Merge pull request from GHSA-vg6w-8w9v-xxqc 2021-01-28 17:40:44 -05:00
LICENSE Correct bugs for LinkController 2015-11-06 20:25:48 -05:00
mkdocs.yml Fix missing Maxmind license key issue (#566) 2020-10-06 14:18:26 -04:00
phpunit.xml Fix unit tests 2016-09-11 16:06:30 -04:00
README.md Update logo link 2018-01-10 20:33:32 -05:00
server.php 2.0 init commit 2015-11-02 23:13:32 -05:00

Polr Logo

🚡 A modern, minimalist, and lightweight URL shortener.

GitHub license GitHub release Builds status Docs

Polr is an intrepid, self-hostable open-source link shortening web application with a robust API. It allows you to host your own URL shortener, to brand your URLs, and to gain control over your data. Polr is especially easy to use, and provides a modern, themable feel.

Getting Started - API Documentation - Contributing - Bugs - IRC

Quickstart

Polr is written in PHP and Lumen, using MySQL as its primary database.

  • To get started with Polr on your server, check out the installation guide. You can clone this repository, or download a release.
  • To get started with the Polr API, check out the API guide.

Installation TL;DR: clone or download this repository, set document root to public/, create MySQL database, go to yoursite.com/setup and follow instructions.

Demo

To test out the demo, head to demo.polr.me and use the following credentials:

  • Username: demo-admin
  • Password: demo-admin

Upgrading Polr

Upgrading from 1.x:

There are breaking changes between 2.x and 1.x; it is not yet possible to automatically upgrade to 2.x.

Upgrading from 2.x:

  • Back up your database and files
  • Update by using git pull or downloading a release
  • Run composer install --no-dev -o to ensure dependencies are up to date
  • Migrate with php artisan migrate to ensure database structure is up to date

Browser Extensions

Libraries

Acknowledgements

We would like to thank Oregon State University's Open Source Lab for providing resources for our infrastructure. The Polr website and demo are hosted on their infrastructure.

Thank you to lastspark for providing our logo's icon.

Versioning

Polr uses Semantic Versioning

License

Copyright (C) 2013-2018 Chaoyi Zha

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.