Skip to content

Commit dc9422a

Browse files
update for 1.1.6
1 parent 1f75dd1 commit dc9422a

File tree

1 file changed

+7
-116
lines changed

1 file changed

+7
-116
lines changed

README.md

Lines changed: 7 additions & 116 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,7 @@
4040
- [Platform](#platform)
4141
- [Supported Browsers](#supported-browsers)
4242
- [Prerequisites](#prerequisites)
43-
- [Installation Docker](#installation-docker)
44-
- [Installation Production](#installation-production)
43+
- [Installation](#installation-production)
4544
- [Installation Development](#installation-development)
4645
- [Contributing](#contributing)
4746
- [License](#license)
@@ -76,10 +75,7 @@ _Note_: Raspberry Pi's Raspbian OS doesn't officially support running MongoDB ye
7675

7776
### Supported Browsers
7877

79-
Currently OctoFarm only support Chrome, Chromium and Firefox. No other browsers have been tested and may produce bugs. Use one of the supported browsers for the best experience.
80-
81-
- Firefox currently has a bug where you can't add printers. This is down to firefox not handling editable html fields properly and you will need to use Chrome to input printers.
82-
78+
All browsers should now be supported in OctoFarm. Please log an issue if this is not the case.
8379

8480

8581
### Prerequisites
@@ -91,124 +87,19 @@ Currently OctoFarm only support Chrome, Chromium and Firefox. No other browsers
9187

9288
On your OctoPrint instance
9389

94-
- Settings -> API
95-
- Copy the API Key someplace easy to get to
90+
- User Name -> User Settings
91+
- Copy the API Key some place easy to get to
9692
- Enabled the "Allow Cross Origin Resource Sharing (CORS)
9793
- Restart OctoPrint
9894
- Repeat for all OctoPrints that will be added to the Farm
9995

10096
#See The WIKI for more detailed instructions than what's available below
10197

102-
### Installation Docker
103-
Currently all docker images are built with linux/amd64 with debian stretch. There are a few different tags available.
104-
105-
#### Example Docker Run
106-
`docker run -d --name octofarm -e "MONGO=mongodb://172.17.0.2/octofarm" -p4000:4000 octofarm/octofarm -e "TZ=America/Chicago" -v '<your persistent folder>/OctoFarm/logs/':'/app/logs/':'rw' -v '<your persistent folder>/OctoFarm/scripts/':'/scripts/':'rw'`
107-
108-
#### Generic Docker-Compose
109-
110-
111-
version: "3"
112-
services:
113-
octofarm:
114-
container_name: octofarm
115-
image: octofarm/octofarm
116-
restart: always
117-
ports:
118-
- 4000:4000
119-
environment:
120-
- MONGO=mongodb://mongo/octofarm
121-
volumes:
122-
- <your persistent folder>/OctoFarm/logs:/app/logs
123-
- <your persistent folder>/OctoFarm/scripts:/scripts
124-
125-
126-
#### OctoFarm (Standalone)
127-
latest: Pulls the latest master release
128-
dev: Pulls the latest development release. (Bleeding edge features, only for testing)
129-
{Version Tag}: Pulls a specific version
130-
131-
132-
#### OctoFarm (Including MongoDB)(Big thanks to MearWolf!)
133-
monolithic-latest: Pulls the latest master release
134-
monolithic-dev: Pulls the latest development release. (Bleeding edge features, only for testing)
135-
monolithic-{Version Tag}: Pulls a specific version
136-
137-
138-
### Installation Production
139-
140-
- Debian/Linux Specific
141-
142-
1. Install the Pre-requisites
143-
144-
```sh
145-
curl -sL https://deb.nodesource.com/setup_13.x | sudo -E bash -
146-
sudo apt-get install -y nodejs
147-
sudo apt install mongodb
148-
sudo apt install git
149-
```
150-
151-
- Alternative
152-
153-
```sh
154-
curl -sL https://deb.nodesource.com/setup_13.x | sudo -E bash -
155-
sudo apt-get install -y nodejs
156-
wget https://repo.mongodb.org/apt/ubuntu/dists/bionic/mongodb-org/4.2/multiverse/binary-amd64/mongodb-org-server_4.2.5_amd64.deb
157-
sudo dpkg -i mongodb-org-server_4.2.5_amd64.deb
158-
sudo apt install git
159-
```
160-
161-
1. Clone the OctoFarm and cd into it's directory.
162-
163-
```sh
164-
git clone https://github.com/NotExpectedYet/OctoFarm.git
165-
166-
cd OctoFarm
98+
### Installation
99+
All user documentation is now moving to OctoFarm.net. Development documentation below.
167100

168-
```
169-
170-
2. Install NPM packages
171-
172-
```sh
173-
npm install
174-
```
175-
176-
3. Edit the /config/db.js file with your database and grab your hosts IP.
177-
178-
```sh
179-
nano config/db.js
180-
```
181-
182-
#### Change 192.168.1.5 to the mongodb server's IP Address (127.0.0.1 if you installed on the same machine, the actual IP Address otherwise), Save the File
183-
184-
#### hostname -I (Take note of the IP Address returned here)
185-
186-
4. Start the system
187-
188-
```sh
189-
npm start
190-
```
191-
192-
#### If the last message you see is '> node app.js > production.log 2> productionError.log' You did it correctly!
193-
194-
5. Load up a browser and add your printers.
195-
196-
```sh
197-
Open a browser and go to http://<IP from hostname -I>:4000
198-
Register a New User ## Password must be six characters
199-
Login as that new User
200-
Click the Setup Printers button
201-
Enter Your First Printers information
202-
- IP
203-
- Port (Typically 80)
204-
- Camera URL (Typically IP:8081/webcam/?action=stream if using a USB camera or Pi Camera )
205-
- APIKey (Gathered during the PreRequisites)
206-
- Click Add Printer
207-
- Repeat for all your OctoPrint Instances
208-
- Click Save
209-
```
101+
https://octofarm.net
210102

211-
- The production version will run without interaction, but currently there are no way to persist other than something like screen on linux, or using a service you create yourself. The logs will be outputted to /logs folder for error and standard operations. Check the error log if your server unexpectedly halts.
212103

213104
### Installation Development
214105

0 commit comments

Comments
 (0)