1
0
mirror of https://github.com/cydrobolt/polr.git synced 2024-11-09 19:52:28 +01:00
Go to file
Tarulia e56fd23b39 [setup] Various cleanups
* config file code more readable
* success/fail messages formatted
* fclose unclosed file-handle
2015-09-25 21:26:59 +02:00
admin Remove external calls to GH raw, replace with something better lataer 2015-06-30 23:32:44 -04:00
css Add pagination fix #58 2015-05-31 23:07:57 +00:00
fonts HUGE update: add features from PaaS, readying for 0.15 Stable 2014-06-21 09:27:18 -04:00
helpers Clean code, add public/private interface settings 2015-01-09 19:19:21 -05:00
img create folders 2014-06-26 16:11:07 -04:00
js Fix bell curve issue with pagination fix #84 2015-06-01 20:14:50 +00:00
vendor/PHPMailer big mailer revamp 2014-11-15 10:27:59 -05:00
.gitignore Clean code, add public/private interface settings 2015-01-09 19:19:21 -05:00
.htaccess Fix annoying indentation 2014-11-29 17:54:03 -05:00
.nginx-config Fix #88 - route t- URLs correctly. 2015-06-04 18:56:38 -04:00
404.php Refactor filenames, and clean up some code 2014-12-28 14:52:06 -05:00
about.php Fix adm check expression 2015-05-31 15:15:02 -04:00
activate.php Refactor filenames, and clean up some code 2014-12-28 14:52:06 -05:00
api.php Silly comments 2015-09-13 13:02:18 -04:00
createurl.php Prettify 2015-09-18 21:59:00 -04:00
forgotpass.php more refactoring 2015-09-13 13:08:31 -04:00
fpass.js forgotten password settings 2014-11-08 15:27:14 -05:00
fpasslib.php more refactoring 2015-09-13 13:08:31 -04:00
handle-login.php Refactor filenames, and clean up some code 2014-12-28 14:52:06 -05:00
handle-register.php Refactor some code and remove unused segments 2015-09-13 13:05:57 -04:00
index.php Add bootstrap to custom url box 2015-05-31 15:53:00 -04:00
INSTALL.txt Add web.config notice 2015-02-14 15:15:45 -05:00
layout-footerlg.php Add mobile responsiveness fix #61 2015-01-09 21:38:28 -05:00
layout-footermd.php Add mobile responsiveness fix #61 2015-01-09 21:38:28 -05:00
layout-headerlg.php Align auth end block correctly 2015-09-13 13:03:46 -04:00
layout-headermd.php Align auth end block correctly 2015-09-13 13:03:46 -04:00
layout-headersm.php Align auth end block correctly 2015-09-13 13:03:46 -04:00
lib-auth.php Rectify issues in previous additions 2015-01-09 20:52:02 -05:00
lib-core.php turn off debug mode 2015-09-11 18:26:55 -04:00
lib-json.php Add missing boilderplate 2014-12-28 21:09:23 -05:00
lib-password.php Refactor filenames, and clean up some code 2014-12-28 14:52:06 -05:00
lib-urlparse.php Add missing boilderplate 2014-12-28 21:09:23 -05:00
LICENSE Create LICENSE 2015-05-31 16:05:31 -04:00
login.php Refactor filenames, and clean up some code 2014-12-28 14:52:06 -05:00
logout.php HUGE update: add features from PaaS, readying for 0.15 Stable 2014-06-21 09:27:18 -04:00
r.php Fix secret URL stats and fix 404 2015-04-01 13:02:49 +00:00
README.md remove openshift option while ip/port env vars are being figured out 2015-08-11 00:43:15 -04:00
register.php Refactor filenames, and clean up some code 2014-12-28 14:52:06 -05:00
setup.php [setup] Various cleanups 2015-09-25 21:26:59 +02:00
stats.php Fix secret URL stats and fix 404 2015-04-01 13:02:49 +00:00
TROUBLESHOOTING.md Create TROUBLESHOOTING.md 2014-12-30 10:34:00 -05:00
version.php Update version.php 2015-06-13 14:02:31 -04:00
web.config.example Add IIS support 2015-02-14 15:14:48 -05:00

Polr

###A beautiful, modern, fast, minimalist, and open-source URL shortening platform in PHP. Polr is an enterprise-class open-source link shortening web application designed to operate at many scales, built on the Software-as-a-Service paradigm. 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.

Polr uses Semantic Versioning http://semver.org/

Manual Installation

  • Unpack Polr, or clone the git repo. Only the git clone option allows quick updating through git pull.
  • Go to the root of your Polr folder (on webserver)
  • Read INSTALL.txt
  • You're ready to go! Check back for updates, and git pull if possible to update Polr. Otherwise, you can download a ZIP from Github and replace your current files. Make sure to keep your config.php!
  • Note: please disable errors on your server if you plan to use Polr in production. Certain warnings are normal, and you should not panic. It is not only unsafe but having errors shown also clutters the interface.

Prerequisites:

Most hosts include these prerequisites in PHP stacks, so you probably won't have to install them yourself.

==================

API Documentation: https://github.com/Cydrobolt/polr/wiki

Would like to contribute? Submit a pull request. Found an issue? Create an issue here: https://github.com/Cydrobolt/polr/issues

Polr operates a channel on the freenode IRC network, which can be used for purposes of development or general support. Webchat

Development

Polr is currently undergoing a massive cleanup/rewrite. Many new features will be implemented, plugins will be supported, and its general code structure will be changed. https://github.com/Cydrobolt/polr/issues/66

==================

####License

Copyright (C) 2015 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, see <http://www.gnu.org/licenses/>.