Skip to content

Commit d40be12

Browse files
finish merge
1 parent fc00d13 commit d40be12

File tree

6 files changed

+23
-95
lines changed

6 files changed

+23
-95
lines changed

user-guide/00-introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ If you are interested in the software internals, take a look at our [developer g
2828
2. Ask a question on our [community forums](https://forum.pioreactor.com/)
2929
2. Contact us at [email protected]
3030

31+
-----
3132

3233
### Compliance
3334

3435
- [EU Declaration of Conformity](https://cdn.shopify.com/s/files/1/0678/1739/files/EU_Declaration_of_Conformity.pdf?v=1745430430)
35-
-

user-guide/03-Extending your Pioreactor/04-Experiment Profiles/02-create-edit-experiment-profiles.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ pioreactors:
192192
- type: update
193193
hours_elapsed: 12
194194
options:
195-
target_rpm: ${{ worker1:stirring:target_rpm + worker1:od_reading:od1.od * 10 }}
195+
target_rpm: ${{ worker1:stirring:target_rpm + worker1:od_reading:od2.od * 10 }}
196196
```
197197

198198

@@ -228,7 +228,7 @@ common:
228228
hours_elapsed: 6
229229
if: ${{ ::stirring:target_rpm <= 500 }}
230230
options:
231-
target_rpm: ${{ ::stirring:target_rpm + 10 * ::od_reading:od1.od }}
231+
target_rpm: ${{ ::stirring:target_rpm + 10 * ::od_reading:od2.od }}
232232
```
233233
234234
### Built-in functions in expressions
@@ -297,7 +297,7 @@ common:
297297
dosing_automation:
298298
actions:
299299
- type: when
300-
condition: ${{::od_reading:od1.od > 2.0}}
300+
condition: ${{::od_reading:od2.od > 2.0}}
301301
hours_elapsed: 0
302302
actions:
303303
- type: start
@@ -353,7 +353,7 @@ Finally, there is more control using the other optional fields:
353353
- type: repeat
354354
hours_elapsed: 6.0
355355
repeat_every_hours: 0.0025 # every 9 seconds
356-
while: ${{ worker1:od_reading:od1.od > 3.0 }}
356+
while: ${{ worker1:od_reading:od2.od > 3.0 }}
357357
actions:
358358
- type: start
359359
options:
@@ -363,7 +363,7 @@ Finally, there is more control using the other optional fields:
363363
- type: repeat
364364
hours_elapsed: 6.0
365365
repeat_every_hours: 0.0025 # every 9 seconds
366-
while: ${{ worker1:od_reading:od1.od > 3.0 }}
366+
while: ${{ worker1:od_reading:od2.od > 3.0 }}
367367
actions:
368368
- type: start
369369
options:
@@ -386,12 +386,12 @@ common:
386386
actions:
387387
- type: update
388388
hours_elapsed: 12.0
389-
if: ${{ ::od_reading:od1.od < od_threshold }}
389+
if: ${{ ::od_reading:od2.od < od_threshold }}
390390
options:
391391
target_temperature: ${{ stationary_phase_temp }}
392392
- type: update
393393
hours_elapsed: 12.0
394-
if: ${{ ::od_reading:od1.od >= od_threshold }}
394+
if: ${{ ::od_reading:od2.od >= od_threshold }}
395395
options:
396396
target_temperature: ${{ growth_phase_temp }}
397397

user-guide/30-Advanced/07-remote-access/01-introduction.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,10 @@ slug: /remote-access
88

99
The Pioreactor connects to your local network, and the UI is hosted locally on the Raspberry Pi. _A priori_, there's no access to view the UI from outside your local network (this is a good thing for security reasons). Let's change that.
1010

11-
With some extra free services, we can safely connect to our Pioreactor cluster remotely. We've documented `2` ways to do this. Both require [command-line access](/user-guide/accessing-raspberry-pi) to the leader Pioreactor and some external services.
11+
With some extra free services, we can safely connect to our Pioreactor cluster remotely. We've documented `1` ways to do this. Both require [command-line access](/user-guide/accessing-raspberry-pi) to the leader Pioreactor and some external services.
1212

1313

14-
- [Option 1: Ngrok](/user-guide/ngrok-remote-access). Remotely access your UI behind a simple username / password.
15-
- [Option 2: Tailscale](/user-guide/tailscale-remote-access). Spin up a simple VPN, and expose your UI to users of your VPN. Also allows for Pioreactors in _different locations_ to be used together over the VPN.
14+
- [Option 1: Tailscale](/user-guide/tailscale-remote-access). Spin up a simple VPN, and expose your UI to users of your VPN. Also allows for Pioreactors in _different locations_ to be used together over the VPN.
1615

1716

1817
## Security

user-guide/30-Advanced/07-remote-access/02-ngrok.md

Lines changed: 0 additions & 68 deletions
This file was deleted.

user-guide/30-Advanced/07-remote-access/03-tailscale.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ slug: /tailscale-remote-access
77
Unlike using Ngrok, this method does not expose your UI to the public internet. To access the UI remotely, you need to join an authenticated VPN. This greatly improves security, but adds a bit of additional work for users.
88

99
:::info
10-
Tailscale is a really really cool service! You may find yourself using it for other projects, too.
10+
Tailscale is a really cool service! You may find yourself using it for other projects, too.
1111
:::
1212

1313

@@ -17,20 +17,17 @@ Tailscale is a really really cool service! You may find yourself using it for ot
1717
4. [SSH into your leader Pioreactor](/user-guide/accessing-raspberry-pi). Install Tailscale for Raspberry Pi with the following: `curl -fsSL https://tailscale.com/install.sh | sh`. You don't need to install anything on the workers.
1818
5. Back in your [Tailscale admin](https://login.tailscale.com/admin/machines), you should see two machines: your computer and the leader Pioreactor. Make note of the ipv4 address for the leader - we will use it below.
1919
6. You should still be able to access `http://pioreactor.local` without any problems.
20-
8. In your config.ini, add your ipv4 address to the `[mqtt]` section:
21-
```
22-
[mqtt]
23-
...
24-
broker_address=<ipv4 address>
25-
...
26-
```
27-
28-
If you have other Pioreactors in your cluster: you likely won't be adding those to tailscale (only adding the leader is necessary for remote access), so in each of the worker config files, add:
29-
```
30-
[mqtt]
31-
broker_address=<leader name>.local
32-
```
33-
And save. This means that your workers will connect "locally" (over the local network), but the UI will connect "remotely".
20+
8. 1. In your **shared config.ini**, add your ipv4 address to the `[mqtt]` section:
21+
```
22+
broker_address=<ipv4 address>
23+
```
24+
2. If you have other Pioreactors in your cluster: you likely won't be adding those to tailscale (only adding the leader is necessary for remote access), so in each of the **workers' config** files, add the new `[mqtt]` section like so:
25+
```
26+
[mqtt]
27+
broker_address=<leader name>.local
28+
```
29+
And save. This means that your workers will connect "locally" (over the local network), but the UI will connect "remotely".
30+
3. Your **leader's config** file should stay the same (confirm it's `localhost`)
3431
3532
7. Now, when you leave the local network, and if you have internet access, you can turn your VPN on and still access `http://<ipv4 address>`. Troubleshooting: try `http://<hostname>`, but confirm that magicDNS is on, too.
3633
8. You can use the Tailscale admin to add users to your VPN, too.

user-guide/50-Troubleshooting/UI troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Another reason might be that your institution's firewall is blocking port 9001.
4646

4747
:::
4848

49-
#### If you are using a remote access service, like ngrok or tailscale
49+
#### If you are using a remote access service, like tailscale
5050

5151
Likely you didn't fill out the `mqtt` `broker_address` parameter in the configuration correctly. See the [remote access instructions](https://docs.pioreactor.com/user-guide/remote-access) again.
5252

0 commit comments

Comments
 (0)