-
Couldn't load subscription status.
- Fork 1
feat: add self-host instructions #951
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
Draft
gildesmarais
wants to merge
13
commits into
main
Choose a base branch
from
feat/selfhost
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+402
−130
Draft
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
3fa0ac6
feat: add self-host instructions
gildesmarais 6491a26
improve deployment knowledge
gildesmarais 5638092
steps
gildesmarais 3d464d2
.
gildesmarais 6c63301
Refine getting started docs (#962)
gildesmarais 3e87f00
Fix automatic updates doc link (#963)
gildesmarais 34e1657
Retarget html2rss configs links (#964)
gildesmarais 04290c3
Rephrase tutorial contribution invite (#965)
gildesmarais 67fe6f4
Update HTTPS guidance to highlight Caddy and Traefik (#966)
gildesmarais 9942762
docs: centralize docker compose quick start (#967)
gildesmarais 9383ddb
Refine reverse proxy guidance for deployment docs (#968)
gildesmarais 7fb69f0
Update deployment docs to reference official docker image (#969)
gildesmarais b2bcd8a
Update index.mdx
gildesmarais File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| --- | ||
| title: "Self-Host Your Own Instance" | ||
| description: "Take control of your information diet. Host your own html2rss instance and join the decentralized web movement." | ||
| sidebar: | ||
| order: 3 | ||
| --- | ||
|
|
||
| Turn any website into an RSS feed. Self-host your own instance and take back control of your information diet. | ||
|
|
||
| ## Quick Start | ||
|
|
||
| 1. Install [Docker](https://docs.docker.com/get-docker/). | ||
| 2. Create a directory for html2rss: | ||
| ```bash | ||
| mkdir html2rss-web && cd html2rss-web | ||
| ``` | ||
| 3. Download the configuration: | ||
| ```bash | ||
| curl -O https://raw.githubusercontent.com/html2rss/html2rss-web/master/docker-compose.yml | ||
| curl -O https://raw.githubusercontent.com/html2rss/html2rss-web/master/config/feeds.yml | ||
| ``` | ||
| 4. Start the instance: | ||
| ```bash | ||
| docker compose up -d | ||
| ``` | ||
| 5. Visit [http://localhost:3000](http://localhost:3000) | ||
| You should see the html2rss-web interface. | ||
|
|
||
| ## Next Steps | ||
|
|
||
| - [Secure your instance](/web-application/how-to/deployment#security) | ||
| - [Enable HTTPS](/web-application/how-to/deployment#https) | ||
| - [Troubleshoot issues](/troubleshooting/troubleshooting) | ||
| - [Join the community](https://github.com/orgs/html2rss/discussions) | ||
|
|
||
| --- | ||
|
|
||
| ## License | ||
|
|
||
| [MIT](https://github.com/html2rss/html2rss/blob/main/LICENSE) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.