Minimal GUI for the api-shortener
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
etc
log
web
.gitignore
LICENSE
README.md
deploy.php.dist

README.md

GUI for API Shortner

Minimal GUI for api-shortener. Supports creation and deletion. Does not display stats.

Usecase: This is intendend only for testing or as a stopgap method while you're implementing the api into your own app. It's probably also good enough for personal use.

DO NOT USE IN PRODUCTION

ApiShort screenshots

Requirements

  • Nginx => 1.7.5

Install

Setup nginx config

Copy nginx.conf.dist to nginx.conf and modify server_name and all paths.

Secure the install

We're using Basic HTTP Auth.

Create file etc/.htpasswd and add the username/password (see google how).

Setup config

Copy config.js.dist to config.js and modify with your information.

Restart nginx

sudo service nginx restart

That's it!

Security consideration:

  1. This has no autentichation/authorisation code.
  2. Your access_code for the API is passed to the client (who can steal it!) as all requests are made with javascript.

This is intended for stopgap/testing purposes. It should be secured with at least Basic HTTP Auth.

Deployment

Deployment is done with Deployer.

Copy config file and configure

cp deploy.php.dist deploy.php
nano deploy.php

run with

dep deploy production