-
Notifications
You must be signed in to change notification settings - 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
Merged
Merged
Changes from 9 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
2a3e3c0
feat: add self-host instructions
gildesmarais bfe8523
improve deployment knowledge
gildesmarais 3b9dd76
steps
gildesmarais 882adcb
.
gildesmarais 5b2159a
remove traefik option
gildesmarais aaea481
.env file
gildesmarais af0f3aa
docs: deduplicate deployment guide intro (#985)
gildesmarais 4de3093
Update src/content/docs/troubleshooting/troubleshooting.mdx
gildesmarais 488b8bf
Update src/content/docs/troubleshooting/troubleshooting.mdx
gildesmarais eabe66f
Update src/content/docs/get-involved/self-hosting.mdx
gildesmarais e4f9fc4
Update src/content/docs/web-application/how-to/deployment.mdx
gildesmarais 3981361
Update src/content/docs/web-application/how-to/deployment.mdx
gildesmarais 5712d4c
Update src/content/docs/getting-started.mdx
gildesmarais ae85f5b
lintfix
gildesmarais 6a29577
Update src/content/docs/getting-started.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
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) | ||
gildesmarais marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - [Troubleshoot issues](/troubleshooting/troubleshooting) | ||
| - [Join the community](https://github.com/orgs/html2rss/discussions) | ||
|
|
||
| --- | ||
|
|
||
| ## License | ||
|
|
||
| [MIT](https://github.com/html2rss/html2rss/blob/main/LICENSE) | ||
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.