Robosats/robosats-startos
1
0
Fork 0
mirror of https://github.com/RoboSats/robosats-startos.git synced 2025-07-21 02:03:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

LAN support! Copy edits in Instructions to reflect

Browse Source
This commit is contained in:
agent
2023-10-20 11:33:13 -06:00
parent c100ea824a
commit dd634e36ce
2 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
instructions.md
View File

@ -4,6 +4,7 @@ A simple and private Lightning P2P exchange you can use directly from StartOS.
You can find a quick start guide, tutorial videos, and detailed documentation at [Learn RoboSats](https://learn.robosats.com/). You can find a quick start guide, tutorial videos, and detailed documentation at [Learn RoboSats](https://learn.robosats.com/).
## Basic Use ## Basic Use
1. Open RoboSats by using the `LAUNCH UI` button. 1. Open RoboSats by using the `LAUNCH UI` button.
2. For the first time using RoboSats, you will be provided a robot token (a unique, transient identifier) - you can create as many of these as you'd like. 2. For the first time using RoboSats, you will be provided a robot token (a unique, transient identifier) - you can create as many of these as you'd like.
**Note: Robots are saved in your "garage." It is strongly recommended to use a new robot every time you start a new exchange.** **IMPORTANT: Robots are saved in your "Garage." It is strongly recommended to use a new robot every time you start a new exchange! Please be aware that your Robot Garage will be different on the Tor (`.onion`) and LAN (`.local`) interfaces. Be sure to follow your trade to completion on the same interface, as it will not be synced between the two.**

11
manifest.yaml
View File

@ -58,12 +58,15 @@ interfaces:
# A human readable name for display in the UI # A human readable name for display in the UI
name: User Interface name: User Interface
# A descriptive description of what the interface does # A descriptive description of what the interface does
description: Your RoboSats Tor Hidden Service address description: Your RoboSats UI addresses
tor-config: tor-config:
# Port mappings are from the external port to the internal container port # Port mappings are from the external port to the internal container port
port-mapping: port-mapping:
80: "12596" 80: "12596"
# Port mappings are from the external port to the internal container port lan-config:
443:
ssl: true
internal: 12596
# Denotes if the service has a user interface to display # Denotes if the service has a user interface to display
ui: true ui: true
# Denotes the protocol specifications used by this interface # Denotes the protocol specifications used by this interface
@ -71,9 +74,7 @@ interfaces:
- tcp - tcp
- http - http
dependencies: {} dependencies: {}
alerts: # alerts:
start: |
ATTENTION: Your browser must have Tor support to use this service.
# Specifies how backups should be run for this service. The default EmbassyOS provided option is to use the duplicity backup library on a system image (compat) # Specifies how backups should be run for this service. The default EmbassyOS provided option is to use the duplicity backup library on a system image (compat)
backup: backup:
create: create: