Simple Node.js server app that allows you to create short aliases for any URL provided.
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.
.gitignore
LICENSE
README.md
config.json
index.js
package.json

README.md

Local alias

Simple Node.js server app that allows you to create short aliases for any URL provided.

Installation

npm install -g local-alias

You can install it on any machine running Node.js. I'm serving it from RaspberryPI 3. Note that this tool makes sense if your hostname is short (e.g. home / http://home/) and the server runs at default 80 port. Therefore please make sure that 80 port is available on your machine.

You can always change the port value in the config.json file.

Here's how to change your hostname on RPi.

Configuration

cd $(npm root -g)/local-alias
nano config.json

Configure your config.json file providing an alias name as a key and URL as the value.

{
    "port": 80,
    "aliases": {
        "oh": "http://openhabianpi:8080/start/index",
        "github": "https://github.com/issues/mentioned"
    }
}

This way you have a quick access to those URLs by simply typing

home/github

in your browser.

You can also link aliases to other aliases (with > prefix) if you don't want to duplicate URLs.

{
    "port": 80,
    "aliases": {
        "forum": "https://community.openhab.org",
        "community": ">forum"
    }
}

You can also create simple URL wildcards with %s in the URL value:

{
    "aliases": {
        "binding": "http://docs.openhab.org/addons/bindings/%s/readme.html",
        "help": "http://docs.openhab.org/search?q=%s"
    }
}

And use it like this:

http://home/binding/airquality

http://home/help/whatever

Running

node local-alias

There's a possibility to run this as a service using forever. But before you do that, you'll need to make sure that you set right permissions to run server on 80 port.

On Debian/Ubuntu:

sudo apt-get install libcap2-bin
sudo setcap cap_net_bind_service=+ep `readlink -f \`which node\``

And then install and run forever

npm i -g forever
sudo forever start $(npm root -g)/local-alias