https://github.com/gavincarr/usher

Tiny personal URL shortener, publishing to various cloud backends
https://github.com/gavincarr/usher

Last synced: 28 days ago
JSON representation

Tiny personal URL shortener, publishing to various cloud backends

• Host: GitHub
• URL: https://github.com/gavincarr/usher
• Owner: gavincarr
• License: mit
• Created: 2020-10-26T22:32:33.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-08-02T23:33:09.000Z (over 3 years ago)
• Last Synced: 2024-06-20T08:15:12.505Z (5 months ago)
• Language: Go
• Size: 59.6 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

Usher

=====

Usher is a tiny personal Url SHortenER that manages a simple local

database of `code => url` mappings, stored in a YAML text file.

Usher mappings can be published to various backends (currently

Amazon S3 and render.com) to provide the actual redirection services.

Installation

------------

    go get github.com/gavincarr/usher/cmd/usher

Usage

-----

### Initialise a new database for the domain you want to use

    usher init example.me

### Add, list, update, and remove mappings

    # Add a mapping with an explicit code (both url+code and code+url work)

    usher add https://github.com/gavincarr/usher usher

    usher add github https://github.com/gavincarr/usher

    # Add a mapping with a randomly generated code

    usher add https://github.com/gavincarr/usher

    # List current mappings

    usher ls

    # Update an existing mapping to a new url

    usher update github https://github.com/gavincarr

    # Delete a mapping

    usher rm github

### Configure and publish to desired backend

    # Report locations of usher root directory, config and database

    usher root

    usher config

    usher db

    # Configure a backend to push to (`type: s3` or `type: render`) e.g.

    $EDITOR $(usher config)

    # Push current mappings to your backend

    usher push

### Help

    usher -h

Author and Licence

------------------

Copyright 2020 Gavin Carr .

usher is available under the terms of the MIT Licence.