3 Commits

Author SHA1 Message Date
429613c67e chore: bump version
All checks were successful
Build and push Docker image / build (push) Successful in 2m49s
Release new version / release (push) Successful in 30s
Update changelog / changelog (push) Successful in 25s
2026-01-08 13:22:27 +01:00
681555fef8 fix: fix subdomain retrieval
All checks were successful
Update changelog / changelog (push) Successful in 25s
2026-01-08 13:20:32 +01:00
066b9884c2 docs: minor markdown rendering fixes to readme
All checks were successful
Update changelog / changelog (push) Successful in 24s
2026-01-07 23:11:18 +01:00
3 changed files with 6 additions and 2 deletions

View File

@@ -26,10 +26,14 @@ Running the back-end is as simple as:
npm ci npm ci
``` ```
- Copying the .env.default file to .env, and customizing it to own preferences. - Copying the .env.default file to .env, and customizing it to own preferences.
**Example:** Say, you want to add a domain to the trusted CORS origins list. To do so, your .env file in your editor of choice and append a comma (`,`) with the origin you want to add (say, `http://example.com`). Your .env file might then look as follows: `TRUSTED_ORIGINS=http://localhost:6568,http://example.com`. **Example:** Say, you want to add a domain to the trusted CORS origins list. To do so, your .env file in your editor of choice and append a comma (`,`) with the origin you want to add (say, `http://example.com`). Your .env file might then look as follows: `TRUSTED_ORIGINS=http://localhost:6568,http://example.com`.
**Important:** Make sure to change the `ACCESS_TOKEN_PRIVATE_KEY` variable to something secure, as this secret value will be used to generate user sessions. **Setting a weak key will allow attackers to potentially bruteforce your secret and forge user tokens!** **Important:** Make sure to change the `ACCESS_TOKEN_PRIVATE_KEY` variable to something secure, as this secret value will be used to generate user sessions. **Setting a weak key will allow attackers to potentially bruteforce your secret and forge user tokens!**
- Pasting your wordlist file into `src/tools/wordlist.ts`. - Pasting your wordlist file into `src/tools/wordlist.ts`.
No wordlist file exists by default in `src/tools/wordlist.ts`. This is because wordlists were meant to be as modular as possible (with the philosophy of "bring your own wordlist"). If you leave that as-is, you'll run into runtime errors. No wordlist file exists by default in `src/tools/wordlist.ts`. This is because wordlists were meant to be as modular as possible (with the philosophy of "bring your own wordlist"). If you leave that as-is, you'll run into runtime errors.
However, if you don't want to provide your own wordlist, and just want to get up and running as fast as possible, you're free to use the provided sample `wordlist.example-large.ts` file. Just copy it into `src/tools/wordlist.ts`: However, if you don't want to provide your own wordlist, and just want to get up and running as fast as possible, you're free to use the provided sample `wordlist.example-large.ts` file. Just copy it into `src/tools/wordlist.ts`:
```sh ```sh
cp wordlist.example-large.ts src/tools/wordlist.ts cp wordlist.example-large.ts src/tools/wordlist.ts

View File

@@ -1,6 +1,6 @@
{ {
"name": "kittyBE", "name": "kittyBE",
"version": "0.0.2", "version": "0.0.3",
"description": "Your go-to place for short and memorable URLs.", "description": "Your go-to place for short and memorable URLs.",
"type": "commonjs", "type": "commonjs",
"devDependencies": { "devDependencies": {

View File

@@ -91,7 +91,7 @@ AppDataSource.initialize().then(async () => {
// Retrieve url, subdomain from request. // Retrieve url, subdomain from request.
let uri: string = req.url.slice(1); // discards / from /abc, /abc -> abc let uri: string = req.url.slice(1); // discards / from /abc, /abc -> abc
let subdomain: string | null = req.headers.host!.replace(rs.fqdn, '') || null; let subdomain: string | null = req.headers.host!.replace(rs.fqdn, '').slice(0, -1) || null; // slice() to remove trailing dot
// Try to lookup the url in DB // Try to lookup the url in DB
const reversedLink: Link | null = await linkService.lookupUriWithExpiryValidation(uri, subdomain); const reversedLink: Link | null = await linkService.lookupUriWithExpiryValidation(uri, subdomain);