Skip to content

Commit

Permalink
Readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
QuinnDamerell committed May 22, 2024
1 parent fb2d46d commit 6f1c522
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 14 deletions.
29 changes: 17 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,43 @@
<p align="center"><img src="https://octoeverywhere.com/img/logo.png" alt="OctoEverywhere's Logo" style="width:100px" /></p>
<h1 align="center" style="margin-bottom:20px"><a href="https://octoeverywhere.com/?source=github_readme">OctoEverywhere</a></h1>

Cloud empower your OctoPrint and Klipper printers with **free, private, and unlimited remote access to your full web control portal from anywhere!** Developed for the maker community, powered by the maker community.
Cloud empower your [OctoPrint](https://octoeverywhere.com/?source=github_readme), [Klipper](https://octoeverywhere.com/klipper?source=github_readme), and [Bambu Lab](https://octoeverywhere.com/bambu?source=github_readme) 3D printers with **free, private, and unlimited remote access, AI print failure detection, and more!** Developed for the maker community, powered by the maker community.

## Features

- 🚀 Free remote access to your full OctoPrint, Mainsail, and Fluidd web portals from anywhere.
- 🤖 **Free & unlimited AI failure detection** that will automatically stop failed prints to save you time and money.
- 🚀 Free remote access to your full OctoPrint, Mainsail, Fluidd, and Bambu Lab web portals from anywhere.
- 🤖 **Free & unlimited [AI failure detection](https://octoeverywhere.com/gadget?source=github_readme)** that will automatically stop failed prints to save you time and money.
- 📷 Full resolution and full frame-rate webcam streaming.
- 📱 Empower your favorite OctoPrint & Klipper iOS and Android apps with [remote access](https://octoeverywhere.com/appsetup?source=github_readme).
- 📺 Live stream your 3D prints to your friends or the entire world with [Live Links](https://octoeverywhere.com/live?source=github_readme).
- 📺 Live stream your 3D prints to your friends or the world with [Live Links](https://octoeverywhere.com/live?source=github_readme).
- 🔔 Instant [printer notifications](https://octoeverywhere.com/notifications?source=github_readme) sent to SMS, Email, Discord, Telegram, Slack, and more.
- 🔗 Share secure access of your full OctoPrint portal with others.
- 🔗 Share secure access to your OctoPrint, Fluidd, or Mainsail portal with others.
- 💪 Full OctoPrint plugin functionality.
- 🤹 Full multicam support.
- ... and much, much more!

## Try It Now!

With a Trustpilot rating of **[4.9/5 stars](https://www.trustpilot.com/review/octoeverywhere.com)** and over **96k** makers are already using OctoEverywhere, what are you waiting for?
With a Trustpilot rating of **[4.9/5 stars](https://www.trustpilot.com/review/octoeverywhere.com)** and over **96k** makers already using OctoEverywhere, what are you waiting for?
<br/>
<br/>
**[Click Here To Try OctoEverywhere Now! It's free and takes less than 20 seconds to setup!](https://octoeverywhere.com/getstarted?source=github_plugin_repo)**
**[Click Here To Try OctoEverywhere Now! It's free and takes less than 20 seconds to set up!](https://octoeverywhere.com/getstarted?source=github_readme)**
<br/>
<br/>

## Bambu Connect Docker Container

If you're using [Bambu Connect](https://octoeverywhere.com/bambu?source=github_readme) to connect a Bambu Lab 3D printer, you can either use our [installer to run directly on any Debian based Linux device,](https://octoeverywhere.com/getstarted?bambu=t&source=github_readme) or you can use our [Docker container to run Bambu Connect](https://blog.octoeverywhere.com/setup-bambu-connect-with-docker-or-docker-compose) on any Windows, Mac, or Linux device.

## OctoPrint And Klipper Plugin Setup

Follow our [Getting Started Guide](https://octoeverywhere.com/getstarted?source=github_readme) to get up and running in less than 20 seconds.

## Bugs & Feedback

We love to hear from you! Please submit bugs or feedback on this github page, our [Discord server](https://discord.gg/v3qbxPee4E), or via [our support system](https://octoeverywhere.com/support).
We love to hear from you! Please submit bugs or feedback on our [Discord server](https://discord.gg/v3qbxPee4E) or via [our support system](https://octoeverywhere.com/support).

## Contributing

Feel free to fork, hack, slash, and PR code! OctoEverywhere is made for the maker community, we appreciate any ideas or help we can get!

## OctoPrint And Klipper Plugin Setup
Feel free to fork, hack, slash, and PR code! OctoEverywhere is made for the maker community; we appreciate any ideas or help we can get!

Follow our [Getting Started Guide](https://octoeverywhere.com/getstarted?source=github_plugin_repo) to get up and running in less than 20 seconds!
4 changes: 2 additions & 2 deletions docker-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ You must map the `/data` folder in your docker container to a directory on your
Once the docker container is running, you need to look at the logs to find the linking URL.

Docker Compose:
`docker-compose logs | grep https://octoeverywhere.com/getstarted`
`docker compose logs | grep https://octoeverywhere.com/getstarted`

Docker:
`docker logs bambu-connect | grep https://octoeverywhere.com/getstarted`
Expand All @@ -41,7 +41,7 @@ Using docker compose is the easiest way to run OctoEverywhere's Bambu Connect us
- Install [Docker and Docker Compose](https://docs.docker.com/compose/install/linux/)
- Clone this repo
- Edit the `./docker-compose.yml` file to enter your environment vars
- Run `docker-compose up -d`
- Run `docker compose up -d`
- Follow the "Linking Your Bambu Connect Plugin" to link the plugin to your account.

## Using Docker
Expand Down

0 comments on commit 6f1c522

Please sign in to comment.