diff --git a/shlink/README.md b/shlink/README.md index 79415d2..c9c4c01 100644 --- a/shlink/README.md +++ b/shlink/README.md @@ -1,6 +1,3 @@ -> Warning these instructions do not work properly at this time. There's also no authentication built in with this deployment. -> I recommend using [kutt.io](https://github.com/StarWhiz/docker_deployment_notes/tree/master/kutt) instead at this time. - Another shortlink alternative https://shlink.io/ This is not a full tutorial but more of a reference. @@ -18,16 +15,11 @@ This is not a full tutorial but more of a reference. Remember to `docker exec -w /etc/caddy caddy caddy reload` after editing your Caddyfile. ``` -u.YOURDOMAIN.com { - reverse_proxy shlink-web:80 -} urls.YOURDOMAIN.com { reverse_proxy shlink:8080 } ``` - - ### docker-compose.yml Change urls.YOURDOMAIN.com under DEFAULT_DOMAIN @@ -35,12 +27,6 @@ Change SOMESTRONGPASSWORD twice. Change GEOLITE_LICENSE_KEY=yoUR1ge2OliTE3key1 (how to get your key here: https://shlink.io/documentation/geolite-license-key/) -Save the docker-compose.yml - -Run `docker-compose up -d` for the first time then run the command `docker exec -it shlink shlink api-key:generate` to get your API key. You'll need this key for the servers.json file. - -After that, do `docker-compose down` we will bring it back up after creating servers.json below this section. - ``` version: '3.3' services: @@ -62,13 +48,6 @@ services: depends_on: - shlink-db - shlink-web: - image: shlinkio/shlink-web-client - container_name: shlink-web - restart: unless-stopped - volumes: - - ./servers.json:/usr/share/nginx/html/servers.json - shlink-db: image: postgres:12.2-alpine container_name: shlink-db @@ -86,19 +65,8 @@ networks: external: name: caddy_net ``` +Save the docker-compose.yml -### servers.json -Get API key from the steps described above. - -``` -[ - { - "name": "My URL Shortener", - "url": "https://urls.YOURDOMAIN.com", - "apiKey": "gibberish-3u10-0129-471j-9140aj2010e9r" - } -] -``` -After you have servers.json and docker-compose.yml set up. Run `docker-compose up -d` one last time. +Run `docker-compose up -d` for the first time to bring up the instance. Then run the command `docker exec -it shlink shlink api-key:generate` to get your API key. You'll need this key to "login" into the webapp. -Visit https://u.YOURDOMAIN.com not https://urls.YOURDOMAIN.com to access the web app. +Visit https://app.shlink.io/ add your server details. The Name is arbitrary. The URL is urls.YOURDOMAIN.com and the API key is the key you generated from `docker exec -it shlink shlink api-key:generate`