voltron/octodocker_deploy
1
0
Fork 0
Code Issues Pull Requests Releases Activity

Update README.md

Browse Source
This commit is contained in:
paukstelis
2021-07-07 12:33:42 -04:00
committed by GitHub
parent fd7008d4cb
commit bfe8ba51b0
1 changed files with 17 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@@ -4,32 +4,32 @@ These files provide a simple bash script for quickly deploying multiple octoprin
# How to use # How to use
* Ready to go images: * Ready to go images:
-- For OctoPi and OctoBuntu installations, you can download an image that contains this repo and all necessary things here: https://bit.ly/3qPfmti * For OctoPi and OctoBuntu installations, you can download an image that contains this repo and all necessary things here: https://bit.ly/3qPfmti
-- OctoPi setup is just like for a normal OctoPi installation. OctoBuntu setup uses standard Ubuntu installation. * OctoPi setup is just like for a normal OctoPi installation. OctoBuntu setup uses standard Ubuntu installation.
-- Follow instructions in README.txt file (either /home/pi/README.txt or /home/octouser/README.txt) * Follow instructions in README.txt file (either /home/pi/README.txt or /home/octouser/README.txt)
-- Default user for Octobuntu images is `octouser` with password `fooselrulz`; please change this password immediately. No root password is set, but this can be done with `sudo passwd`. * Default user for Octobuntu images is `octouser` with password `fooselrulz`; please change this password immediately. No root password is set, but this can be done with `sudo passwd`.
* Stand-alone usage: * Stand-alone usage:
-- This is for more advanced users that have realtively high command line/Linux familiarity. * This is for more advanced users that have realtively high command line/Linux familiarity.
-- Start up Octoprint for the first time to setup a base instance profile (running on localhost:5000). The base profile will be edited in several places with `INSTANCE` to allow modifications during deployment. You can make this as extensive as you like as far as adding different printers, plugins, etc. They can be added for each instance later. This only needs to be done once. * Start up Octoprint for the first time to setup a base instance profile (running on localhost:5000). The base profile will be edited in several places with `INSTANCE` to allow modifications during deployment. You can make this as extensive as you like as far as adding different printers, plugins, etc. They can be added for each instance later. This only needs to be done once.
-- During setup, edit the restart script: `sudo systemctl restart INSTANCE` * During setup, edit the restart script: `sudo systemctl restart INSTANCE`
![alt text](/deploy_01.png) ![alt text](/deploy_01.png)
-- After the initial setup is done, reload the server and edit the Additional Serial Port field: `/dev/octo_INSTANCE` * After the initial setup is done, reload the server and edit the Additional Serial Port field: `/dev/octo_INSTANCE`
![alt text](/deploy_02.png) ![alt text](/deploy_02.png)
-- You can also edit the server name under apperance with: `INSTANCE` * You can also edit the server name under apperance with: `INSTANCE`
![alt text](/deploy_03.png) ![alt text](/deploy_03.png)
-- SAVE your changes, then STOP your currently running octoprint server (Ctrl+C in the terminal you started is sufficient) * SAVE your changes, then STOP your currently running octoprint server (Ctrl+C in the terminal you started is sufficient)
-- Make sure whichever printer you are installing for is not plugged in via USB * Make sure whichever printer you are installing for is not plugged in via USB
-- Go to wherever you downloaded octoprint_deploy: `$ cd octoprint_deploy` * Go to wherever you downloaded octoprint_deploy: `$ cd octoprint_deploy`
-- Run the bash script: `$ sudo ./addnew_printer.sh` * Run the bash script: `$ sudo ./addnew_printer.sh`
-- Select 'Other' option and fill in the appropriate information. * Select 'Other' option and fill in the appropriate information.
# Other Features # Other Features
* Uninstall * Uninstall
-- Any instance installed through these scripts can be removed by running the uninstall script. If you use one of the pre-made images, don't remove your base instance! * Any instance installed through these scripts can be removed by running the uninstall script. If you use one of the pre-made images, don't remove your base instance!
* USB testing * USB testing
-- The script `usbtesting.sh` provides information to help debug auto-detection. * The script `usbtesting.sh` provides information to help debug auto-detection.
* Add printer udev entries * Add printer udev entries
-- You can use the `printer_udev.sh` script to just use the serial number/USB port detection features of these scripts to add udev entires to your machine. This way if you have multiple octoprint instances being run through other means (docker) they can always be linked to a particular device. This will default to /dev/octo_[INSTANCE], so you must change the additional serial port field (see above) in your octoprint setup in order to see these (easiest is just to use /dev/octo_*). * You can use the `printer_udev.sh` script to just use the serial number/USB port detection features of these scripts to add udev entires to your machine. This way if you have multiple octoprint instances being run through other means (docker) they can always be linked to a particular device. This will default to /dev/octo_[INSTANCE], so you must change the additional serial port field (see above) in your octoprint setup in order to see these (easiest is just to use /dev/octo_*).
Because each octoprint instance is coming from the same source files, any global modifications you make to octoprint (adding/removing plugins, updating octoprint) are all automatically applied to all of your instances and will take effect when you restart that instance. Because each octoprint instance is coming from the same source files, any global modifications you make to octoprint (adding/removing plugins, updating octoprint) are all automatically applied to all of your instances and will take effect when you restart that instance.