sus/readme.md

# sus

sus 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
update readme to markdown file 2022-05-26 15:14:24 +00:00			`# sus`
initial commit 2022-05-26 01:08:50 +00:00
:amogus: 2022-05-26 15:21:10 +00:00			`sus URL shortener`
update documenation, susmng 2022-05-26 14:51:14 +00:00

update readme to markdown file 2022-05-26 15:14:24 +00:00			`## usage`
update documenation, susmng 2022-05-26 14:51:14 +00:00
update readme to markdown file 2022-05-26 15:14:24 +00:00			`- creating a new shortlink at https://pls.cx/shortlink`
update readme 2022-05-26 15:03:38 +00:00
format readme code blocks 2022-05-26 15:16:21 +00:00			`susmng [-s pls.cx] create -l shortlink -v https://example.com`
update readme 2022-05-26 15:03:38 +00:00
update readme to markdown file 2022-05-26 15:14:24 +00:00			`- deleting the shortlink https://pls.cx/shortlink`
update readme 2022-05-26 15:03:38 +00:00
format readme code blocks 2022-05-26 15:16:21 +00:00			`susmng [-s pls.cx] delete -l shortlink -v confirm`
update readme 2022-05-26 15:03:38 +00:00
			`susmng will assume the first server in the 'secrets' section if the -s flag is`
			`not provided.`


update readme to markdown file 2022-05-26 15:14:24 +00:00			`## installation`
update readme 2022-05-26 15:03:38 +00:00
update readme to markdown file 2022-05-26 15:14:24 +00:00			`### running the server`
update documenation, susmng 2022-05-26 14:51:14 +00:00
			`1. generate the secret used to create and delete shortlinks`

format readme code blocks 2022-05-26 15:16:21 +00:00			echo SECRET=`pwgen -s 64 1` >> .env
update documenation, susmng 2022-05-26 14:51:14 +00:00
			`2. run the services`

format readme code blocks 2022-05-26 15:16:21 +00:00			`docker-compose up -d --build`
update documenation, susmng 2022-05-26 14:51:14 +00:00
update readme to markdown file 2022-05-26 15:14:24 +00:00			`#### 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`
update documenation, susmng 2022-05-26 14:51:14 +00:00
			`1. install susmng`

format readme code blocks 2022-05-26 15:16:21 +00:00			`make install-susmng`
update documenation, susmng 2022-05-26 14:51:14 +00:00
			`2. create config files`

format readme code blocks 2022-05-26 15:16:21 +00:00			`susmng init`
update documenation, susmng 2022-05-26 14:51:14 +00:00
format readme code blocks 2022-05-26 15:16:21 +00:00			3. edit config files (`~/.config/susmng/config.json`) to add your secrets