Skip to content

Commit

Permalink
fixing .env.example to show correct shortner url
Browse files Browse the repository at this point in the history
  • Loading branch information
DonKoko committed Aug 1, 2024
1 parent de7e273 commit 9149385
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
3 changes: 2 additions & 1 deletion .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ SERVER_URL="http://localhost:3000"

# Used for shortening URLs of QR codes. Optional
# If present, the QR code will be generated with a shortened URL
# URL_SHORTENER="https://hey.lo/"
# Should not include the protocol (http/https) or a trailing slash
# URL_SHORTENER="eam.sh"


APP_NAME="Shelf"
Expand Down
2 changes: 1 addition & 1 deletion docs/url-shortener.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ The redirection is handled via the `urlShortener` middleware.

Using the shortener is super easy.

1. Add an env variable with your shortner domain: `URL_SHORTENER="https://hey.lo/"`. You can refer to `.env.example` for further example
1. Add an env variable with your shortner domain: `URL_SHORTENER="hey.lo"`. You can refer to `.env.example` for further example. The domain should not include the protocol (http/https) or a trailing slash
2. Make sure you point your short domain to your application server
3. Enjoy

0 comments on commit 9149385

Please sign in to comment.