Skip to content

Commit

Permalink
Fix pages workflow (#333)
Browse files Browse the repository at this point in the history
* Add allowed endpoint `github.com:443`

* Change link breaks from crlf to lf
  • Loading branch information
waybackarchiver committed Mar 7, 2023
1 parent 79b191c commit 7344fb6
Show file tree
Hide file tree
Showing 13 changed files with 257 additions and 253 deletions.
4 changes: 4 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,11 @@ jobs:
egress-policy: block
disable-telemetry: true
allowed-endpoints: >
github.com:443
api.github.com:443
pypi.org:443
pip.pypa.io:443
files.pythonhosted.org:443
- name: Check out code base
uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
Expand Down
24 changes: 12 additions & 12 deletions docs/integrations/archive-today.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Wayback to archive.today
---

Wayback relies on [archive.today](https://archive.today/) as an upstream service for wayback and playback.
You can enable or disable this feature using the `--is` flag or the `WAYBACK_ENABLE_IS` environment variable, which is enabled by default.

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.

## Further reading

- [archive.today - Wikipedia](https://en.wikipedia.org/wiki/Archive.today)
---
title: Wayback to archive.today
---

Wayback relies on [archive.today](https://archive.today/) as an upstream service for wayback and playback.
You can enable or disable this feature using the `--is` flag or the `WAYBACK_ENABLE_IS` environment variable, which is enabled by default.

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.

## Further reading

- [archive.today - Wikipedia](https://en.wikipedia.org/wiki/Archive.today)
24 changes: 12 additions & 12 deletions docs/integrations/internet-archive.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Wayback to Internet Archive
---

Wayback relies on [Internet Archive](https://archive.org/) as an upstream service for wayback and playback.
You can enable or disable this feature using the `--ia` flag or the `WAYBACK_ENABLE_IA` environment variable, which is enabled by default.

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.

## Further reading

- [Internet Archive - Wikipedia](https://en.wikipedia.org/wiki/Internet_Archive)
---
title: Wayback to Internet Archive
---

Wayback relies on [Internet Archive](https://archive.org/) as an upstream service for wayback and playback.
You can enable or disable this feature using the `--ia` flag or the `WAYBACK_ENABLE_IA` environment variable, which is enabled by default.

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.

## Further reading

- [Internet Archive - Wikipedia](https://en.wikipedia.org/wiki/Internet_Archive)
22 changes: 11 additions & 11 deletions docs/integrations/ipfs.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Wayback to IPFS
---

Wayback relies on the InterPlanetary File System ([IPFS](https://ipfs.tech/)) as an upstream service to store complete web pages,
including all related assets like JavaScript, CSS, and fonts. This allows for seamless playback of archived web pages,
ensuring that the user experience is identical to the original site.

You can enable or disable this feature using the `--ip` flag or the `WAYBACK_ENABLE_IP` environment variable, which is enabled by default.

The code for wayback's implementation of the Internet Archive integration can be found in the [wabarc/rivet](https://github.com/wabarc/rivet) repository.
---
title: Wayback to IPFS
---

Wayback relies on the InterPlanetary File System ([IPFS](https://ipfs.tech/)) as an upstream service to store complete web pages,
including all related assets like JavaScript, CSS, and fonts. This allows for seamless playback of archived web pages,
ensuring that the user experience is identical to the original site.

You can enable or disable this feature using the `--ip` flag or the `WAYBACK_ENABLE_IP` environment variable, which is enabled by default.

The code for wayback's implementation of the Internet Archive integration can be found in the [wabarc/rivet](https://github.com/wabarc/rivet) repository.
80 changes: 40 additions & 40 deletions docs/integrations/mastodon.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,40 @@
---
title: Interactive with Mastodon
---

## How to build a Mastodon Bot

You can choose any Mastodon instance. Here, we will be using Mastodon.social as an example.

To create a Mastodon application, you can follow these steps:

1. Log in to your Mastodon account.
2. Go to "Settings" > "[Development](https://mastodon.social/settings/applications)" > "[New Application](https://mastodon.social/settings/applications/new)".
3. Enter the following information:
- **Application name**: The name of your application.
- **Application website**: The website associated with your application.
- **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.
- 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`.
4. Click "Submit".
5. On the next page, you will see your application's client ID and client secret. These will be needed to authenticate your application.

You can find more information about creating Mastodon applications in the Mastodon documentation: https://docs.joinmastodon.org/client/token/

## Configuration

After creating a Mastodon application, you can find the `Client key`, `Client secret`, and `Your access token` on the application details page.

Next, place these keys in the environment or configuration file:

The next step, place them below key on env or config file:

- `WAYBACK_MASTODON_KEY`: Client key
- `WAYBACK_MASTODON_SECRET`: Client secret
- `WAYBACK_MASTODON_TOKEN`: Your access token

Additionally, you must specify the Mastodon server by setting the `WAYBACK_MASTODON_SERVER` variable.

## Further reading

- [Fediverse Observer](https://mastodon.fediverse.observer/list)
- [fediverse.space](https://fediverse.space/)
---
title: Interactive with Mastodon
---

## How to build a Mastodon Bot

You can choose any Mastodon instance. Here, we will be using Mastodon.social as an example.

To create a Mastodon application, you can follow these steps:

1. Log in to your Mastodon account.
2. Go to "Settings" > "[Development](https://mastodon.social/settings/applications)" > "[New Application](https://mastodon.social/settings/applications/new)".
3. Enter the following information:
- **Application name**: The name of your application.
- **Application website**: The website associated with your application.
- **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.
- 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`.
4. Click "Submit".
5. On the next page, you will see your application's client ID and client secret. These will be needed to authenticate your application.

You can find more information about creating Mastodon applications in the Mastodon documentation: https://docs.joinmastodon.org/client/token/

## Configuration

After creating a Mastodon application, you can find the `Client key`, `Client secret`, and `Your access token` on the application details page.

Next, place these keys in the environment or configuration file:

The next step, place them below key on env or config file:

- `WAYBACK_MASTODON_KEY`: Client key
- `WAYBACK_MASTODON_SECRET`: Client secret
- `WAYBACK_MASTODON_TOKEN`: Your access token

Additionally, you must specify the Mastodon server by setting the `WAYBACK_MASTODON_SERVER` variable.

## Further reading

- [Fediverse Observer](https://mastodon.fediverse.observer/list)
- [fediverse.space](https://fediverse.space/)
58 changes: 29 additions & 29 deletions docs/integrations/matrix.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
---
title: Interactive with Matrix
---

## How to build a Matrix Bot

You can choose any Matrix server. Here, we will be using **matrix.org** and **Element** as an example.

To register a Matrix account, follow these steps:

1. Open [Element](https://app.element.io/) and click "Create Account".
2. Fill in the required information.
3. Log in and create a **public room** for publishing (optional).
4. Go to **Room Settings** > **Advanced**, you can find **Internal room ID** (optional).

## Configuration

After creating a Matrix account, you will have the `Homeserver`, `User ID`, `Password`, and `Internal room ID`.

Next, place these keys in the environment or configuration file:

- `WAYBACK_MATRIX_HOMESERVER`: Homeserver of your choice, defaults to `matrix.org`
- `WAYBACK_MATRIX_USERID`: User ID, e.g. `@alice:matrix.org`
- `WAYBACK_MATRIX_ROOMID`: Internal room ID
- `WAYBACK_MATRIX_PASSWORD`: Password from your registration step.

## Further reading

- [Guides for Developers](https://matrix.org/docs/develop/)
---
title: Interactive with Matrix
---

## How to build a Matrix Bot

You can choose any Matrix server. Here, we will be using **matrix.org** and **Element** as an example.

To register a Matrix account, follow these steps:

1. Open [Element](https://app.element.io/) and click "Create Account".
2. Fill in the required information.
3. Log in and create a **public room** for publishing (optional).
4. Go to **Room Settings** > **Advanced**, you can find **Internal room ID** (optional).

## Configuration

After creating a Matrix account, you will have the `Homeserver`, `User ID`, `Password`, and `Internal room ID`.

Next, place these keys in the environment or configuration file:

- `WAYBACK_MATRIX_HOMESERVER`: Homeserver of your choice, defaults to `matrix.org`
- `WAYBACK_MATRIX_USERID`: User ID, e.g. `@alice:matrix.org`
- `WAYBACK_MATRIX_ROOMID`: Internal room ID
- `WAYBACK_MATRIX_PASSWORD`: Password from your registration step.

## Further reading

- [Guides for Developers](https://matrix.org/docs/develop/)
44 changes: 22 additions & 22 deletions docs/integrations/nostr.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
---
title: Publish to Nostr
---

## How to build a Nostr Bot

Wayback currently only supports publishing to Nostr as the Nostr Protocol is still under development.

Select any relay to generate a private key (here's a [guide](https://nostr.how/) to help you get started).

## Configuration

After creating a new account, you will have the `private key`.

Next, place these keys in the environment or configuration file:

- `WAYBACK_NOSTR_RELAY_URL`: Nostr relay server url, multiple separated by comma.
- `WAYBACK_NOSTR_PRIVATE_KEY`: The private key of a Nostr account.

## Further reading

- [Nostr Protocol](https://github.com/nostr-protocol/nostr)
---
title: Publish to Nostr
---

## How to build a Nostr Bot

Wayback currently only supports publishing to Nostr as the Nostr Protocol is still under development.

Select any relay to generate a private key (here's a [guide](https://nostr.how/) to help you get started).

## Configuration

After creating a new account, you will have the `private key`.

Next, place these keys in the environment or configuration file:

- `WAYBACK_NOSTR_RELAY_URL`: Nostr relay server url, multiple separated by comma.
- `WAYBACK_NOSTR_PRIVATE_KEY`: The private key of a Nostr account.

## Further reading

- [Nostr Protocol](https://github.com/nostr-protocol/nostr)
52 changes: 26 additions & 26 deletions docs/integrations/notion.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
---
title: Publish to Notion
---

## How to build a Notion Bot

1. Sign up for a Notion account, if you don't have one already.
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.
3. Give your integration a name and click on "Create Integration".
4. On the integration page, click on "Add a new integration".
5. Select "Internal Integration" and click "Submit".
6. On the next page, you will see your "Integration Token". Copy this token as you will need it later.
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".
8. In the "Invite people" field, enter the name of your integration and select it from the list.
9. Select the appropriate permissions for your integration and click on "Send".

Note: Wayback currently only supports publishing to Nostr.

## Configuration

After creating a new account, you will have the `Integration Token` and `Notion database ID`.

Next, place these keys in the environment or configuration file:

- `WAYBACK_NOTION_TOKEN`: Notion integration token.
- `WAYBACK_NOTION_DATABASE_ID`: Notion database ID for archiving results.
---
title: Publish to Notion
---

## How to build a Notion Bot

1. Sign up for a Notion account, if you don't have one already.
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.
3. Give your integration a name and click on "Create Integration".
4. On the integration page, click on "Add a new integration".
5. Select "Internal Integration" and click "Submit".
6. On the next page, you will see your "Integration Token". Copy this token as you will need it later.
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".
8. In the "Invite people" field, enter the name of your integration and select it from the list.
9. Select the appropriate permissions for your integration and click on "Send".

Note: Wayback currently only supports publishing to Nostr.

## Configuration

After creating a new account, you will have the `Integration Token` and `Notion database ID`.

Next, place these keys in the environment or configuration file:

- `WAYBACK_NOTION_TOKEN`: Notion integration token.
- `WAYBACK_NOTION_DATABASE_ID`: Notion database ID for archiving results.
66 changes: 33 additions & 33 deletions docs/integrations/slack.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
---
title: Interactive with Slack
---

## How to build a Slack App

Steps to create a new app:

1. Open [Slack API](https://api.slack.com/apps).
2. Click "Create New App" and "From Scratch".
2. Generate an App-Level Token with the `connections:write` scope.
3. Enable Socket Mode.
4. Enable Events
- Subscribe to bot events: `app_mention` and `message.im`.
- Subscribe to events on behalf of users: `message.im`.
5. Setting OAuth & Permissions User Token Scopes: `chat:write`, `files:write`.
6. Install the app to your workspace and obtain the `Bot User OAuth Token`.
7. In the App Home section, check `Allow users to send Slash commands and messages from the messages tab`.
8. Optionally, create a channel for publishing and note down the `Channel ID` by viewing the channel details.

## Configuration

After creating a new app, you will have the `Bot User OAuth Token` and `Channel ID`.

Next, place these keys in the environment or configuration file:

- `WAYBACK_SLACK_BOT_TOKEN`: Bot User OAuth Token.
- `WAYBACK_SLACK_CHANNEL`: Channel ID for publishing (optional).
- `WAYBACK_SLACK_HELPTEXT`: Provide a help message for users to reference (optional).

## Further reading

- [Slack API Documentation](https://api.slack.com/)
---
title: Interactive with Slack
---

## How to build a Slack App

Steps to create a new app:

1. Open [Slack API](https://api.slack.com/apps).
2. Click "Create New App" and "From Scratch".
2. Generate an App-Level Token with the `connections:write` scope.
3. Enable Socket Mode.
4. Enable Events
- Subscribe to bot events: `app_mention` and `message.im`.
- Subscribe to events on behalf of users: `message.im`.
5. Setting OAuth & Permissions User Token Scopes: `chat:write`, `files:write`.
6. Install the app to your workspace and obtain the `Bot User OAuth Token`.
7. In the App Home section, check `Allow users to send Slash commands and messages from the messages tab`.
8. Optionally, create a channel for publishing and note down the `Channel ID` by viewing the channel details.

## Configuration

After creating a new app, you will have the `Bot User OAuth Token` and `Channel ID`.

Next, place these keys in the environment or configuration file:

- `WAYBACK_SLACK_BOT_TOKEN`: Bot User OAuth Token.
- `WAYBACK_SLACK_CHANNEL`: Channel ID for publishing (optional).
- `WAYBACK_SLACK_HELPTEXT`: Provide a help message for users to reference (optional).

## Further reading

- [Slack API Documentation](https://api.slack.com/)
Loading

0 comments on commit 7344fb6

Please sign in to comment.