Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Docs updates #78

Merged
merged 2 commits into from
Sep 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/infrastructure/auth/basic-auth.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# HTTP Basic Authentication

We support that you put your feeds protected behind [HTTP basic authentication](https://en.wikipedia.org/wiki/Basic_access_authentication), please contact us at support@prisjakt.nu in order to provide us with credentials for your feed.
We support that you put your feeds protected behind [HTTP basic authentication](https://en.wikipedia.org/wiki/Basic_access_authentication). Credentials can be set in [Business Center](https://business.prisjakt.nu).

:::info Use https

Expand Down
2 changes: 1 addition & 1 deletion docs/infrastructure/auth/digest-authentication.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# HTTP Digest Authentication

We support that you put your feeds protected behind [HTTP digest authentication](https://en.wikipedia.org/wiki/Digest_access_authentication), please contact us at support@prisjakt.nu in order to provide us with credentials for your feed.
We support that you put your feeds protected behind [HTTP digest authentication](https://en.wikipedia.org/wiki/Digest_access_authentication). Credentials can be set in [Business Center](https://business.prisjakt.nu).

:::info Use https

Expand Down
8 changes: 2 additions & 6 deletions docs/infrastructure/auth/ftp-credentials.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
# Ftp Credentials

For legacy we support supplying credentials for ftp in the following format:

```
ftp://username:password@ftp.yourserver.com/your-feed.xml
```
For legacy we support ftp authentication. Credentials can be set in [Business Center](https://business.prisjakt.nu).

:::danger Insecure

The ftp protocol is insecure in itself (even if extensions exist) and we only support supplying credentials directly in the URI. This should not be considered secure but a bere way of preventing bots and other public traffic. For better security use [https](/infrastructure/protocols/http.md) in combination with any of the [authentication methods](/infrastructure/auth) suitable for https.
The ftp protocol is insecure in itself (even if extensions exist). This should not be considered secure but a bere way of preventing bots and other public traffic. For better security use [https](/infrastructure/protocols/http.md) in combination with any of the [authentication methods](/infrastructure/auth) suitable for https.

:::
9 changes: 9 additions & 0 deletions docs/infrastructure/auth/header-auth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Header Authentication

We support that you put your feeds protected by authentication header. Header name and value can be set in [Business Center](https://business.prisjakt.nu).

Example header:

```
API-ACCES-KEY: secretkey
```
2 changes: 1 addition & 1 deletion docs/infrastructure/web-server-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ For optimal results it is preferable if you host your feeds with the support for

- **Use [gzip compression](https://en.wikipedia.org/wiki/HTTP_compression) or [brotli compression](https://en.wikipedia.org/wiki/Brotli) and send a correct compression header**, this will reduce the amount of data sent and improve handling time as well
- Ensure that you **send a correct [content-length](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Length) header**, this makes it easier for us to ensure that we have ingested your whole feed and not gotten aborted by any network issues or anything similar, our retry policies will also behave better
- **Disable bot protection** for our [user agent](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent): `feed-ingestion-service`, some bot protection systems will cause issues for us when we read your feed. If possible, then allow requests from our user agent to come through
- **Disable bot protection** for our [user agent](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent): `prisjakt-feed-ingestion-service`, some bot protection systems will cause issues for us when we read your feed. If possible, then allow requests from our user agent to come through

:::info We use dynamically assigned ip´s
We do not support a configuration where you disable bot protection for specific ip addresses. Our agents are cloud based and spin up and change after load, hence they get dynamically assigned ip addresses that vary.
Expand Down
14 changes: 7 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@
"typecheck": "tsc"
},
"dependencies": {
"@docusaurus/core": "^3.1.1",
"@docusaurus/plugin-client-redirects": "^3.1.1",
"@docusaurus/plugin-google-gtag": "^3.1.1",
"@docusaurus/preset-classic": "^3.1.1",
"@docusaurus/theme-mermaid": "^3.1.1",
"@docusaurus/core": "^3.5.2",
"@docusaurus/plugin-client-redirects": "^3.5.2",
"@docusaurus/plugin-google-gtag": "^3.5.2",
"@docusaurus/preset-classic": "^3.5.2",
"@docusaurus/theme-mermaid": "^3.5.2",
"@mdx-js/react": "^3.0.1",
"baseui": "^0.0.0-next-6fabc7134",
"clsx": "^2.1.0",
"docusaurus-lunr-search": "^3.3.2",
"docusaurus-lunr-search": "^3.5.0",
"eta": "^3.4.0",
"handlebars": "^4.7.8",
"prism-react-renderer": "^2.3.1",
Expand All @@ -34,7 +34,7 @@
"styletron-react": "^6.1.1"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.1.1",
"@docusaurus/module-type-aliases": "^3.5.2",
"@tsconfig/docusaurus": "^2.0.3",
"typescript": "^5.4.3"
},
Expand Down
Loading
Loading