mirror of
https://github.com/cydrobolt/polr.git
synced 2024-11-10 04:02:28 +01:00
63 lines
3.1 KiB
Markdown
63 lines
3.1 KiB
Markdown
# [](https://project.polr.me)
|
|
|
|
:aerial_tramway: A modern, minimalist, and lightweight URL shortener.
|
|
|
|
[]()
|
|
[](https://travis-ci.org/cydrobolt/polr)
|
|
[](http://polr.readthedocs.org/en/latest/)
|
|
|
|
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](http://docs.polr.me/en/latest/user-guide/installation/) - [API Documentation](http://docs.polr.me/en/latest/developer-guide/api/) - [Contributing](https://github.com/cydrobolt/polr/blob/master/.github/CONTRIBUTING.md) - [Bugs](https://github.com/cydrobolt/polr/issues) - [IRC](http://webchat.freenode.net/?channels=#polr)
|
|
|
|
### 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](http://docs.polr.me/en/latest/user-guide/installation/). You can clone this repository, or download a [release](https://github.com/cydrobolt/polr/releases).
|
|
- To get started with the Polr API, check out the [API guide](http://docs.polr.me/en/latest/developer-guide/api/).
|
|
|
|
|
|
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](http://demo.polr.me) and use the following credentials:
|
|
|
|
- Username: `demo-admin`
|
|
- Password: `demo-admin`
|
|
|
|
### Upgrading Polr
|
|
|
|
Please do not attempt to upgrade directly to 2.x.
|
|
|
|
Polr 1.x currently cannot be upgraded to 2.x automatically. There are breaking changes in the API, configuration files, and database structure. It is safe to upgrade between different versions in the 1.x arch, which do not have breaking changes. Always backup your database and configuration files before upgrading Polr.
|
|
|
|
#### Browser Extensions
|
|
|
|
* Safari - [Polr.safariextension](https://github.com/cleverdevil/Polr.safariextension).
|
|
|
|
####Versioning
|
|
|
|
Polr uses [Semantic Versioning](http://semver.org/)
|
|
|
|
|
|
####License
|
|
|
|
|
|
Copyright (C) 2013-2016 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.
|