Sink-UrlShortener/docs/configuration.md
ccbikai 52187d1ff6 feat: disable query string redirection by default
Enhances security and performance by preventing query strings from being carried over during redirection, aligning with best practices.
2024-07-20 18:34:49 +08:00

1.7 KiB

Sink Configuration

Sink provides some configuration options, which can be referred to in .env.example.

NUXT_PUBLIC_PREVIEW_MODE

Sets the site to demo mode, the generated links will expire after 24 hours, and the links cannot be edited or deleted.

NUXT_PUBLIC_SLUG_DEFAULT_LENGTH

Sets the default length of the generated SLUG.

NUXT_REDIRECT_STATUS_CODE

Redirects default to use HTTP 301 status code, you can set it to 302/307/308.

Cache links can speed up access, but setting them too long may result in slow changes taking effect. The default value is 60 seconds.

NUXT_REDIRECT_WITH_QUERY

URL parameters are not carried during link redirection by default and it is not recommended to enable this feature.

NUXT_HOME_URL

The default Sink homepage is the introduction page, you can replace it with your own website.

NUXT_DATASET

The Analytics Engine DATASET, it is not recommended to modify unless you need to switch databases and clear historical data.

NUXT_AI_MODEL

You can modify the large model yourself. The supported names can be viewed at Workers AI Models.

NUXT_AI_PROMPT

Supports custom prompts, it is recommended to keep the placeholder {slugRegex}.

Default prompt:

You are a URL shortening assistant, please shorten the URL provided by the user into a SLUG. The SLUG information must come from the URL itself, do not make any assumptions. A SLUG is human-readable and should not exceed three words and can be validated using regular expressions {slugRegex} . Only the best one is returned, the format must be JSON reference {"slug": "example-slug"}