diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml index 4a09c74e..b6fe3cbc 100644 --- a/.github/workflows/docker.yml +++ b/.github/workflows/docker.yml @@ -14,6 +14,7 @@ on: paths-ignore: - "**.md" - 'snapcraft.yaml' + - 'requirements.txt' - '.github/**' - '!.github/workflows/docker.yml' pull_request: @@ -22,6 +23,7 @@ on: paths-ignore: - "**.md" - 'snapcraft.yaml' + - 'requirements.txt' - '.github/**' - '!.github/workflows/docker.yml' workflow_dispatch: diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 0d120404..e90cf314 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -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 diff --git a/docs/integrations/archive-today.md b/docs/integrations/archive-today.md index d64744c1..a77149e2 100644 --- a/docs/integrations/archive-today.md +++ b/docs/integrations/archive-today.md @@ -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) diff --git a/docs/integrations/internet-archive.md b/docs/integrations/internet-archive.md index 1e478a3b..79e38b96 100644 --- a/docs/integrations/internet-archive.md +++ b/docs/integrations/internet-archive.md @@ -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) diff --git a/docs/integrations/ipfs.md b/docs/integrations/ipfs.md index 67b6d170..d2c79112 100644 --- a/docs/integrations/ipfs.md +++ b/docs/integrations/ipfs.md @@ -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. diff --git a/docs/integrations/mastodon.md b/docs/integrations/mastodon.md index b29ffb1c..e9319c11 100644 --- a/docs/integrations/mastodon.md +++ b/docs/integrations/mastodon.md @@ -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/) diff --git a/docs/integrations/matrix.md b/docs/integrations/matrix.md index dc67414a..23680485 100644 --- a/docs/integrations/matrix.md +++ b/docs/integrations/matrix.md @@ -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/) diff --git a/docs/integrations/nostr.md b/docs/integrations/nostr.md index 94941342..421362bb 100644 --- a/docs/integrations/nostr.md +++ b/docs/integrations/nostr.md @@ -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) diff --git a/docs/integrations/notion.md b/docs/integrations/notion.md index 26fee7e7..4aebf4f4 100644 --- a/docs/integrations/notion.md +++ b/docs/integrations/notion.md @@ -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. diff --git a/docs/integrations/slack.md b/docs/integrations/slack.md index f8501da8..bf436d98 100644 --- a/docs/integrations/slack.md +++ b/docs/integrations/slack.md @@ -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/) diff --git a/docs/integrations/telegraph.md b/docs/integrations/telegraph.md index 311b15c2..ad79011e 100644 --- a/docs/integrations/telegraph.md +++ b/docs/integrations/telegraph.md @@ -1,11 +1,11 @@ ---- -title: Wayback to Telegraph ---- - -[Telegraph](https://telegra.ph/) – a publishing tool that lets you create richly formatted posts with photos and all sorts of embedded stuff. - -Wayback relies on [Telegraph](https://telegra.ph/) as an upstream service storing sanitized web pages. -You can enable or disable this feature using the `--ph` flag or the `WAYBACK_ENABLE_PH` environment variable, which is enabled by default. -The content is saved using a new anonymous account generated by wayback each time, and is not associated with the requester. - -The code for wayback's implementation of the Telegraph integration can be found in the [wabarc/telegra.ph](https://github.com/wabarc/telegra.ph) repository. +--- +title: Wayback to Telegraph +--- + +[Telegraph](https://telegra.ph/) – a publishing tool that lets you create richly formatted posts with photos and all sorts of embedded stuff. + +Wayback relies on [Telegraph](https://telegra.ph/) as an upstream service storing sanitized web pages. +You can enable or disable this feature using the `--ph` flag or the `WAYBACK_ENABLE_PH` environment variable, which is enabled by default. +The content is saved using a new anonymous account generated by wayback each time, and is not associated with the requester. + +The code for wayback's implementation of the Telegraph integration can be found in the [wabarc/telegra.ph](https://github.com/wabarc/telegra.ph) repository. diff --git a/docs/integrations/twitter.md b/docs/integrations/twitter.md index be9ffc24..4714446f 100644 --- a/docs/integrations/twitter.md +++ b/docs/integrations/twitter.md @@ -1,37 +1,37 @@ ---- -title: Interactive with Twitter ---- - -## How to build a Twitter Bot - -Steps to create a new bot: - -1. Create a Twitter account or use an existing one. Go to [signup](https://twitter.com/signup) if you need to create a new account. -2. Go to [Projects & Apps](https://developer.twitter.com/en/portal/projects-and-apps) and sign in with your Twitter account. -3. Click "Create an App" and fill in the required information such as the app name, description, and website. -4. On the "App details" page, click on the "Keys and tokens" tab. -5. Click the "Generate" button under the "Consumer Keys" section to generate the "Consumer Key" and "Consumer Secret" for your app. -6. Scroll down to the "Access token & access token secret" section and click the "Generate" button to generate the "Access Token" and "Access Token Secret" for your app. -7. Copy the "Consumer Key", "Consumer Secret", "Access Token", and "Access Token Secret" and store them in a secure location. You will need them later to authenticate your bot. -8. Place environment or configuration file for your bot, making sure to include the necessary authentication with the API using the keys and tokens generated in step 5 and 6. -9. Test your bot and make sure it is working as expected. -10. Once your bot is ready, deploy it to a hosting service or a server so it can run continuously. -11. Monitor your bot's activity and performance, and make any necessary adjustments. - -Some things to keep in mind when creating a Twitter bot: - -- Follow the Twitter rules and policies, as violating them can result in your bot being suspended or banned. -- Do not use your bot to spam or harass other Twitter users. -- Make sure your bot has a clear purpose and is not creating unnecessary noise on the platform. -- Monitor your bot's activity and make adjustments as needed to improve its performance and behavior. - -## Configuration - -After creating a new bot, you will have the `Consumer Keys`, `Consumer Secret`, `Access Token` and `Access Token Secret`. - -Next, place these keys in the environment or configuration file: - -- `WAYBACK_TWITTER_CONSUMER_KEY`: The customer key of your Twitter application. -- `WAYBACK_TWITTER_CONSUMER_SECRET`: The customer secret of your Twitter application. -- `WAYBACK_TWITTER_ACCESS_TOKEN`: The access token of your Twitter application. -- `WAYBACK_TWITTER_ACCESS_SECRET`: The access secret of your Twitter application. +--- +title: Interactive with Twitter +--- + +## How to build a Twitter Bot + +Steps to create a new bot: + +1. Create a Twitter account or use an existing one. Go to [signup](https://twitter.com/signup) if you need to create a new account. +2. Go to [Projects & Apps](https://developer.twitter.com/en/portal/projects-and-apps) and sign in with your Twitter account. +3. Click "Create an App" and fill in the required information such as the app name, description, and website. +4. On the "App details" page, click on the "Keys and tokens" tab. +5. Click the "Generate" button under the "Consumer Keys" section to generate the "Consumer Key" and "Consumer Secret" for your app. +6. Scroll down to the "Access token & access token secret" section and click the "Generate" button to generate the "Access Token" and "Access Token Secret" for your app. +7. Copy the "Consumer Key", "Consumer Secret", "Access Token", and "Access Token Secret" and store them in a secure location. You will need them later to authenticate your bot. +8. Place environment or configuration file for your bot, making sure to include the necessary authentication with the API using the keys and tokens generated in step 5 and 6. +9. Test your bot and make sure it is working as expected. +10. Once your bot is ready, deploy it to a hosting service or a server so it can run continuously. +11. Monitor your bot's activity and performance, and make any necessary adjustments. + +Some things to keep in mind when creating a Twitter bot: + +- Follow the Twitter rules and policies, as violating them can result in your bot being suspended or banned. +- Do not use your bot to spam or harass other Twitter users. +- Make sure your bot has a clear purpose and is not creating unnecessary noise on the platform. +- Monitor your bot's activity and make adjustments as needed to improve its performance and behavior. + +## Configuration + +After creating a new bot, you will have the `Consumer Keys`, `Consumer Secret`, `Access Token` and `Access Token Secret`. + +Next, place these keys in the environment or configuration file: + +- `WAYBACK_TWITTER_CONSUMER_KEY`: The customer key of your Twitter application. +- `WAYBACK_TWITTER_CONSUMER_SECRET`: The customer secret of your Twitter application. +- `WAYBACK_TWITTER_ACCESS_TOKEN`: The access token of your Twitter application. +- `WAYBACK_TWITTER_ACCESS_SECRET`: The access secret of your Twitter application. diff --git a/docs/integrations/web.md b/docs/integrations/web.md index b65b6e99..ac0e97e1 100644 --- a/docs/integrations/web.md +++ b/docs/integrations/web.md @@ -1,19 +1,19 @@ ---- -title: Interactive with Web Service ---- - -## How to build a Web Service - -Wayback supports serving both **Clear Web** and **Onion Service**. If the Tor binary or torrc file is missing, the Onion Service feature will be ignored. - -## Configuration - -After installation, you need to provide the required keys by placing them in the environment or configuration file. This allows you to customize the configuration based on your needs. - -- `WAYBACK_LISTEN_ADDR`: The listen address for the HTTP server, defaults to `0.0.0.0:8964`. -- `WAYBACK_TOR_PRIVKEY`: The private key for Onion Service. -- `WAYBACK_TOR_LOCAL_PORT`: Local port for Onion Service, also support for a reverse proxy. This is ignored if `WAYBACK_LISTEN_ADDR` is set. -- `WAYBACK_TOR_REMOTE_PORTS`: Remote ports for Onion Service, e.g. `WAYBACK_TOR_REMOTE_PORTS=80,81`. -- `WAYBACK_TORRC`: Using torrc for Onion Service, defaults to `/etc/tor/torrc`. - -Note: To run a Onion Service for the first time, you need to keep the `private key`, which can be seen from the log output. +--- +title: Interactive with Web Service +--- + +## How to build a Web Service + +Wayback supports serving both **Clear Web** and **Onion Service**. If the Tor binary or torrc file is missing, the Onion Service feature will be ignored. + +## Configuration + +After installation, you need to provide the required keys by placing them in the environment or configuration file. This allows you to customize the configuration based on your needs. + +- `WAYBACK_LISTEN_ADDR`: The listen address for the HTTP server, defaults to `0.0.0.0:8964`. +- `WAYBACK_TOR_PRIVKEY`: The private key for Onion Service. +- `WAYBACK_TOR_LOCAL_PORT`: Local port for Onion Service, also support for a reverse proxy. This is ignored if `WAYBACK_LISTEN_ADDR` is set. +- `WAYBACK_TOR_REMOTE_PORTS`: Remote ports for Onion Service, e.g. `WAYBACK_TOR_REMOTE_PORTS=80,81`. +- `WAYBACK_TORRC`: Using torrc for Onion Service, defaults to `/etc/tor/torrc`. + +Note: To run a Onion Service for the first time, you need to keep the `private key`, which can be seen from the log output. diff --git a/requirements.txt b/requirements.txt index 562f669c..d008aa71 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,7 +3,7 @@ mkdocs==1.4.2 # Python Markdown Extensions pygments==2.14 -pymdown-extensions==9.9 +pymdown-extensions==9.10 # MkDocs Plugins mkdocs-exclude-search==0.6.5