sus/readme.md

sus

simple URL shortener

usage

• creating a new shortlink at https://pls.cx/shortlink

  susmng [-s pls.cx] create -l shortlink -v https://example.com

• deleting the shortlink https://pls.cx/shortlink

  susmng [-s pls.cx] delete -l shortlink -v confirm

susmng will assume the first server in the 'secrets' section if the -s flag is not provided.

installation

running the server

1. generate the secret used to create and delete shortlinks

   echo SECRET=pwgen -s 64 1 >> .env

2. run the services

   docker-compose up -d --build

server environment variables

• SECRET - the secret used for signature verification
• LISTEN_ADDRESS - the address the server is listening on (default is 0.0.0.0:80)

setting up susmng

1. install susmng

   make install-susmng

2. create config files

   susmng init

3. edit config files (~/.config/susmng/config.json) to add your secrets