Skip to content

Commit 7344fb6

Browse files
waybackarchiverwaybackarchiver
committed
Fix pages workflow (#333)
* Add allowed endpoint `github.com:443` * Change link breaks from crlf to lf
1 parent 79b191c commit 7344fb6

File tree

13 files changed

+257
-253
lines changed

13 files changed

+257
-253
lines changed

‎.github/workflows/pages.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,11 @@ jobs:
3939
egress-policy: block
4040
disable-telemetry: true
4141
allowed-endpoints: >
42+
github.com:443
4243
api.github.com:443
44+
pypi.org:443
45+
pip.pypa.io:443
46+
files.pythonhosted.org:443
4347
4448
- name: Check out code base
4549
uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0

‎docs/integrations/archive-today.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
---
2-
title: Wayback to archive.today
3-
---
4-
5-
Wayback relies on [archive.today](https://archive.today/) as an upstream service for wayback and playback.
6-
You can enable or disable this feature using the `--is` flag or the `WAYBACK_ENABLE_IS` environment variable, which is enabled by default.
7-
8-
The code for wayback's implementation of the Internet Archive integration can be found in the [wabarc/archive.is](https://github.com/wabarc/archive.is) repository.
9-
10-
## Further reading
11-
12-
- [archive.today - Wikipedia](https://en.wikipedia.org/wiki/Archive.today)
1+
---
2+
title: Wayback to archive.today
3+
---
4+
5+
Wayback relies on [archive.today](https://archive.today/) as an upstream service for wayback and playback.
6+
You can enable or disable this feature using the `--is` flag or the `WAYBACK_ENABLE_IS` environment variable, which is enabled by default.
7+
8+
The code for wayback's implementation of the Internet Archive integration can be found in the [wabarc/archive.is](https://github.com/wabarc/archive.is) repository.
9+
10+
## Further reading
11+
12+
- [archive.today - Wikipedia](https://en.wikipedia.org/wiki/Archive.today)

‎docs/integrations/internet-archive.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
---
2-
title: Wayback to Internet Archive
3-
---
4-
5-
Wayback relies on [Internet Archive](https://archive.org/) as an upstream service for wayback and playback.
6-
You can enable or disable this feature using the `--ia` flag or the `WAYBACK_ENABLE_IA` environment variable, which is enabled by default.
7-
8-
The code for wayback's implementation of the Internet Archive integration can be found in the [wabarc/archive.org](https://github.com/wabarc/archive.org) repository.
9-
10-
## Further reading
11-
12-
- [Internet Archive - Wikipedia](https://en.wikipedia.org/wiki/Internet_Archive)
1+
---
2+
title: Wayback to Internet Archive
3+
---
4+
5+
Wayback relies on [Internet Archive](https://archive.org/) as an upstream service for wayback and playback.
6+
You can enable or disable this feature using the `--ia` flag or the `WAYBACK_ENABLE_IA` environment variable, which is enabled by default.
7+
8+
The code for wayback's implementation of the Internet Archive integration can be found in the [wabarc/archive.org](https://github.com/wabarc/archive.org) repository.
9+
10+
## Further reading
11+
12+
- [Internet Archive - Wikipedia](https://en.wikipedia.org/wiki/Internet_Archive)

‎docs/integrations/ipfs.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
---
2-
title: Wayback to IPFS
3-
---
4-
5-
Wayback relies on the InterPlanetary File System ([IPFS](https://ipfs.tech/)) as an upstream service to store complete web pages,
6-
including all related assets like JavaScript, CSS, and fonts. This allows for seamless playback of archived web pages,
7-
ensuring that the user experience is identical to the original site.
8-
9-
You can enable or disable this feature using the `--ip` flag or the `WAYBACK_ENABLE_IP` environment variable, which is enabled by default.
10-
11-
The code for wayback's implementation of the Internet Archive integration can be found in the [wabarc/rivet](https://github.com/wabarc/rivet) repository.
1+
---
2+
title: Wayback to IPFS
3+
---
4+
5+
Wayback relies on the InterPlanetary File System ([IPFS](https://ipfs.tech/)) as an upstream service to store complete web pages,
6+
including all related assets like JavaScript, CSS, and fonts. This allows for seamless playback of archived web pages,
7+
ensuring that the user experience is identical to the original site.
8+
9+
You can enable or disable this feature using the `--ip` flag or the `WAYBACK_ENABLE_IP` environment variable, which is enabled by default.
10+
11+
The code for wayback's implementation of the Internet Archive integration can be found in the [wabarc/rivet](https://github.com/wabarc/rivet) repository.

‎docs/integrations/mastodon.md‎

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,40 @@
1-
---
2-
title: Interactive with Mastodon
3-
---
4-
5-
## How to build a Mastodon Bot
6-
7-
You can choose any Mastodon instance. Here, we will be using Mastodon.social as an example.
8-
9-
To create a Mastodon application, you can follow these steps:
10-
11-
1. Log in to your Mastodon account.
12-
2. Go to "Settings" > "[Development](https://mastodon.social/settings/applications)" > "[New Application](https://mastodon.social/settings/applications/new)".
13-
3. Enter the following information:
14-
- **Application name**: The name of your application.
15-
- **Application website**: The website associated with your application.
16-
- **Redirect URI**: The URI where users will be redirected after authentication. This can be any valid URI, but it must match the redirect URI specified in your code.
17-
- Scopes: The scopes your application requires. These determine the actions your application can perform on behalf of the user. The required minimum scopes are: `read:statuses`, `read:notifications`, `write:statuses`, `write:notifications` and `write:conversations`.
18-
4. Click "Submit".
19-
5. On the next page, you will see your application's client ID and client secret. These will be needed to authenticate your application.
20-
21-
You can find more information about creating Mastodon applications in the Mastodon documentation: https://docs.joinmastodon.org/client/token/
22-
23-
## Configuration
24-
25-
After creating a Mastodon application, you can find the `Client key`, `Client secret`, and `Your access token` on the application details page.
26-
27-
Next, place these keys in the environment or configuration file:
28-
29-
The next step, place them below key on env or config file:
30-
31-
- `WAYBACK_MASTODON_KEY`: Client key
32-
- `WAYBACK_MASTODON_SECRET`: Client secret
33-
- `WAYBACK_MASTODON_TOKEN`: Your access token
34-
35-
Additionally, you must specify the Mastodon server by setting the `WAYBACK_MASTODON_SERVER` variable.
36-
37-
## Further reading
38-
39-
- [Fediverse Observer](https://mastodon.fediverse.observer/list)
40-
- [fediverse.space](https://fediverse.space/)
1+
---
2+
title: Interactive with Mastodon
3+
---
4+
5+
## How to build a Mastodon Bot
6+
7+
You can choose any Mastodon instance. Here, we will be using Mastodon.social as an example.
8+
9+
To create a Mastodon application, you can follow these steps:
10+
11+
1. Log in to your Mastodon account.
12+
2. Go to "Settings" > "[Development](https://mastodon.social/settings/applications)" > "[New Application](https://mastodon.social/settings/applications/new)".
13+
3. Enter the following information:
14+
- **Application name**: The name of your application.
15+
- **Application website**: The website associated with your application.
16+
- **Redirect URI**: The URI where users will be redirected after authentication. This can be any valid URI, but it must match the redirect URI specified in your code.
17+
- Scopes: The scopes your application requires. These determine the actions your application can perform on behalf of the user. The required minimum scopes are: `read:statuses`, `read:notifications`, `write:statuses`, `write:notifications` and `write:conversations`.
18+
4. Click "Submit".
19+
5. On the next page, you will see your application's client ID and client secret. These will be needed to authenticate your application.
20+
21+
You can find more information about creating Mastodon applications in the Mastodon documentation: https://docs.joinmastodon.org/client/token/
22+
23+
## Configuration
24+
25+
After creating a Mastodon application, you can find the `Client key`, `Client secret`, and `Your access token` on the application details page.
26+
27+
Next, place these keys in the environment or configuration file:
28+
29+
The next step, place them below key on env or config file:
30+
31+
- `WAYBACK_MASTODON_KEY`: Client key
32+
- `WAYBACK_MASTODON_SECRET`: Client secret
33+
- `WAYBACK_MASTODON_TOKEN`: Your access token
34+
35+
Additionally, you must specify the Mastodon server by setting the `WAYBACK_MASTODON_SERVER` variable.
36+
37+
## Further reading
38+
39+
- [Fediverse Observer](https://mastodon.fediverse.observer/list)
40+
- [fediverse.space](https://fediverse.space/)

‎docs/integrations/matrix.md‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
1-
---
2-
title: Interactive with Matrix
3-
---
4-
5-
## How to build a Matrix Bot
6-
7-
You can choose any Matrix server. Here, we will be using **matrix.org** and **Element** as an example.
8-
9-
To register a Matrix account, follow these steps:
10-
11-
1. Open [Element](https://app.element.io/) and click "Create Account".
12-
2. Fill in the required information.
13-
3. Log in and create a **public room** for publishing (optional).
14-
4. Go to **Room Settings** > **Advanced**, you can find **Internal room ID** (optional).
15-
16-
## Configuration
17-
18-
After creating a Matrix account, you will have the `Homeserver`, `User ID`, `Password`, and `Internal room ID`.
19-
20-
Next, place these keys in the environment or configuration file:
21-
22-
- `WAYBACK_MATRIX_HOMESERVER`: Homeserver of your choice, defaults to `matrix.org`
23-
- `WAYBACK_MATRIX_USERID`: User ID, e.g. `@alice:matrix.org`
24-
- `WAYBACK_MATRIX_ROOMID`: Internal room ID
25-
- `WAYBACK_MATRIX_PASSWORD`: Password from your registration step.
26-
27-
## Further reading
28-
29-
- [Guides for Developers](https://matrix.org/docs/develop/)
1+
---
2+
title: Interactive with Matrix
3+
---
4+
5+
## How to build a Matrix Bot
6+
7+
You can choose any Matrix server. Here, we will be using **matrix.org** and **Element** as an example.
8+
9+
To register a Matrix account, follow these steps:
10+
11+
1. Open [Element](https://app.element.io/) and click "Create Account".
12+
2. Fill in the required information.
13+
3. Log in and create a **public room** for publishing (optional).
14+
4. Go to **Room Settings** > **Advanced**, you can find **Internal room ID** (optional).
15+
16+
## Configuration
17+
18+
After creating a Matrix account, you will have the `Homeserver`, `User ID`, `Password`, and `Internal room ID`.
19+
20+
Next, place these keys in the environment or configuration file:
21+
22+
- `WAYBACK_MATRIX_HOMESERVER`: Homeserver of your choice, defaults to `matrix.org`
23+
- `WAYBACK_MATRIX_USERID`: User ID, e.g. `@alice:matrix.org`
24+
- `WAYBACK_MATRIX_ROOMID`: Internal room ID
25+
- `WAYBACK_MATRIX_PASSWORD`: Password from your registration step.
26+
27+
## Further reading
28+
29+
- [Guides for Developers](https://matrix.org/docs/develop/)

‎docs/integrations/nostr.md‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
1-
---
2-
title: Publish to Nostr
3-
---
4-
5-
## How to build a Nostr Bot
6-
7-
Wayback currently only supports publishing to Nostr as the Nostr Protocol is still under development.
8-
9-
Select any relay to generate a private key (here's a [guide](https://nostr.how/) to help you get started).
10-
11-
## Configuration
12-
13-
After creating a new account, you will have the `private key`.
14-
15-
Next, place these keys in the environment or configuration file:
16-
17-
- `WAYBACK_NOSTR_RELAY_URL`: Nostr relay server url, multiple separated by comma.
18-
- `WAYBACK_NOSTR_PRIVATE_KEY`: The private key of a Nostr account.
19-
20-
## Further reading
21-
22-
- [Nostr Protocol](https://github.com/nostr-protocol/nostr)
1+
---
2+
title: Publish to Nostr
3+
---
4+
5+
## How to build a Nostr Bot
6+
7+
Wayback currently only supports publishing to Nostr as the Nostr Protocol is still under development.
8+
9+
Select any relay to generate a private key (here's a [guide](https://nostr.how/) to help you get started).
10+
11+
## Configuration
12+
13+
After creating a new account, you will have the `private key`.
14+
15+
Next, place these keys in the environment or configuration file:
16+
17+
- `WAYBACK_NOSTR_RELAY_URL`: Nostr relay server url, multiple separated by comma.
18+
- `WAYBACK_NOSTR_PRIVATE_KEY`: The private key of a Nostr account.
19+
20+
## Further reading
21+
22+
- [Nostr Protocol](https://github.com/nostr-protocol/nostr)

‎docs/integrations/notion.md‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
1-
---
2-
title: Publish to Notion
3-
---
4-
5-
## How to build a Notion Bot
6-
7-
1. Sign up for a Notion account, if you don't have one already.
8-
2. Create a new Integration by going to the [Notion API page](https://developers.notion.com/docs/getting-started) and clicking on "My integrations" in the top-right corner of the page.
9-
3. Give your integration a name and click on "Create Integration".
10-
4. On the integration page, click on "Add a new integration".
11-
5. Select "Internal Integration" and click "Submit".
12-
6. On the next page, you will see your "Integration Token". Copy this token as you will need it later.
13-
7. Grant your integration access to a database by sharing the database with your integration. To do this, go to the database you want to use with your bot, click on the three-dot menu, and select "Share".
14-
8. In the "Invite people" field, enter the name of your integration and select it from the list.
15-
9. Select the appropriate permissions for your integration and click on "Send".
16-
17-
Note: Wayback currently only supports publishing to Nostr.
18-
19-
## Configuration
20-
21-
After creating a new account, you will have the `Integration Token` and `Notion database ID`.
22-
23-
Next, place these keys in the environment or configuration file:
24-
25-
- `WAYBACK_NOTION_TOKEN`: Notion integration token.
26-
- `WAYBACK_NOTION_DATABASE_ID`: Notion database ID for archiving results.
1+
---
2+
title: Publish to Notion
3+
---
4+
5+
## How to build a Notion Bot
6+
7+
1. Sign up for a Notion account, if you don't have one already.
8+
2. Create a new Integration by going to the [Notion API page](https://developers.notion.com/docs/getting-started) and clicking on "My integrations" in the top-right corner of the page.
9+
3. Give your integration a name and click on "Create Integration".
10+
4. On the integration page, click on "Add a new integration".
11+
5. Select "Internal Integration" and click "Submit".
12+
6. On the next page, you will see your "Integration Token". Copy this token as you will need it later.
13+
7. Grant your integration access to a database by sharing the database with your integration. To do this, go to the database you want to use with your bot, click on the three-dot menu, and select "Share".
14+
8. In the "Invite people" field, enter the name of your integration and select it from the list.
15+
9. Select the appropriate permissions for your integration and click on "Send".
16+
17+
Note: Wayback currently only supports publishing to Nostr.
18+
19+
## Configuration
20+
21+
After creating a new account, you will have the `Integration Token` and `Notion database ID`.
22+
23+
Next, place these keys in the environment or configuration file:
24+
25+
- `WAYBACK_NOTION_TOKEN`: Notion integration token.
26+
- `WAYBACK_NOTION_DATABASE_ID`: Notion database ID for archiving results.

‎docs/integrations/slack.md‎

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
1-
---
2-
title: Interactive with Slack
3-
---
4-
5-
## How to build a Slack App
6-
7-
Steps to create a new app:
8-
9-
1. Open [Slack API](https://api.slack.com/apps).
10-
2. Click "Create New App" and "From Scratch".
11-
2. Generate an App-Level Token with the `connections:write` scope.
12-
3. Enable Socket Mode.
13-
4. Enable Events
14-
- Subscribe to bot events: `app_mention` and `message.im`.
15-
- Subscribe to events on behalf of users: `message.im`.
16-
5. Setting OAuth & Permissions User Token Scopes: `chat:write`, `files:write`.
17-
6. Install the app to your workspace and obtain the `Bot User OAuth Token`.
18-
7. In the App Home section, check `Allow users to send Slash commands and messages from the messages tab`.
19-
8. Optionally, create a channel for publishing and note down the `Channel ID` by viewing the channel details.
20-
21-
## Configuration
22-
23-
After creating a new app, you will have the `Bot User OAuth Token` and `Channel ID`.
24-
25-
Next, place these keys in the environment or configuration file:
26-
27-
- `WAYBACK_SLACK_BOT_TOKEN`: Bot User OAuth Token.
28-
- `WAYBACK_SLACK_CHANNEL`: Channel ID for publishing (optional).
29-
- `WAYBACK_SLACK_HELPTEXT`: Provide a help message for users to reference (optional).
30-
31-
## Further reading
32-
33-
- [Slack API Documentation](https://api.slack.com/)
1+
---
2+
title: Interactive with Slack
3+
---
4+
5+
## How to build a Slack App
6+
7+
Steps to create a new app:
8+
9+
1. Open [Slack API](https://api.slack.com/apps).
10+
2. Click "Create New App" and "From Scratch".
11+
2. Generate an App-Level Token with the `connections:write` scope.
12+
3. Enable Socket Mode.
13+
4. Enable Events
14+
- Subscribe to bot events: `app_mention` and `message.im`.
15+
- Subscribe to events on behalf of users: `message.im`.
16+
5. Setting OAuth & Permissions User Token Scopes: `chat:write`, `files:write`.
17+
6. Install the app to your workspace and obtain the `Bot User OAuth Token`.
18+
7. In the App Home section, check `Allow users to send Slash commands and messages from the messages tab`.
19+
8. Optionally, create a channel for publishing and note down the `Channel ID` by viewing the channel details.
20+
21+
## Configuration
22+
23+
After creating a new app, you will have the `Bot User OAuth Token` and `Channel ID`.
24+
25+
Next, place these keys in the environment or configuration file:
26+
27+
- `WAYBACK_SLACK_BOT_TOKEN`: Bot User OAuth Token.
28+
- `WAYBACK_SLACK_CHANNEL`: Channel ID for publishing (optional).
29+
- `WAYBACK_SLACK_HELPTEXT`: Provide a help message for users to reference (optional).
30+
31+
## Further reading
32+
33+
- [Slack API Documentation](https://api.slack.com/)

0 commit comments

Comments
 (0)