instructions update (#2)

* Remove properties
* Auth only by default
* Remove auto-login
* Autogenerate password in config
* Bump bitcoind version
* Update instructions.md
* Changed wrapper to startos

---------

Co-authored-by: Matt Hill <[email protected]>

Dockerfile

@@ -60,13 +60,5 @@ export PUID=1000\n\
 export PGID=1000\n\
 export TZ=Etc/UTC\n\
 export TITLE="$(yq e .title /root/data/start9/config.yaml)"\n\
-export CHECK_LOGIN="$(yq e .auto_login /root/data/start9/config.yaml)"\n\
-if test "$CHECK_LOGIN" = "true"; then\n\
-  sed -i 's/^username=.*/username='abc'/g' /etc/xrdp/xrdp.ini\n\
-  sed -i 's/^password=.*/password='"$(yq e .password /root/data/start9/config.yaml)"'/g' /etc/xrdp/xrdp.ini\n\
-  echo "Autologin is enabled."\n\
-else\n\
-  echo "Autologin is disabled."\n\
-  export AUTO_LOGIN=false\n\
-fi\n\
+export AUTO_LOGIN=false\n\
 printf "%s\n" "useTorForBtc=false" "btcNodes=bitcoind.embassy:8333" "bannedSeedNodes=" "bannedBtcNodes=165.227.34.198:8333,btc1.dnsalias.net:8333" "bannedPriceRelayNodes=" > /config/.local/share/Bisq/bisq.properties' /init

Makefile

@@ -34,14 +34,14 @@ clean:
 scripts/embassy.js: $(TS_FILES)
 	deno bundle scripts/embassy.ts scripts/embassy.js
 
-docker-images/aarch64.tar: Dockerfile docker_entrypoint.sh
+docker-images/aarch64.tar: Dockerfile
 ifeq ($(ARCH),x86_64)
 else
 	mkdir -p docker-images
 	docker buildx build --tag start9/$(PKG_ID)/main:$(PKG_VERSION) --build-arg ARCH=aarch64 --platform=linux/arm64 -o type=docker,dest=docker-images/aarch64.tar .
 endif
 
-docker-images/x86_64.tar: Dockerfile docker_entrypoint.sh
+docker-images/x86_64.tar: Dockerfile
 ifeq ($(ARCH),aarch64)
 else
 	mkdir -p docker-images

README.md

@@ -63,8 +63,8 @@ Now you are ready to build the `bisq` package!
 Clone the project locally:
 
 ```
-git clone https://github.com/Start9Labs/bisq-wrapper.git
-cd bisq-wrapper
+git clone https://github.com/Start9Labs/bisq-startos.git
+cd bisq-startos
 ```
 
 ## Building

instructions.md

@@ -1,34 +1,36 @@
 # Instructions for Bisq
 
-Welcome to Bisq, a decentralized exchange that allows you to trade cryptocurrencies in a true sovereign way. Here's how to get started:
+Welcome to Bisq, a decentralized exchange that allows you to trade cryptocurrencies in a true sovereign way.
 
-Configure Bisq by clicking on the **"Config"** button and saving default values or making any necessary changes to the **Bisq Title**, **Automatic Login**, and **Password** settings. Then click on the **"Save"** button.
+## Why Run Bisq on a Server?
 
-**Note:** The default username is **abc** and the default password is **cba**.
+Bisq is a client application, usually run on a laptop or desktop. In order for trades to complete, however, it is necessary for your computer to be online. This means if you enter a trade on your laptop, you cannot close your laptop until the trade completes; otherwise it might fail.
 
-Once Bisq is configured, you are ready to start the service.
+*By running Bisq on a server, which is online 24/7, you can enter a trade and go about your life!*
 
-## Running Bisq from a web browser:
+## Username and Password
 
-Running Bisq from a web browser is the preferred method as it can be used on LAN and Tor on any Tor-enabled browser.
+The default username for Bisq is `abc`, and you have the option to change the password in config at any time.
 
-1. Launch the Bisq App by clicking on the **"LAUNCH UI"** button. This will open Bisq in your default web browser.
-2. Depending on your configuration, you may be logged in automatically or prompted for the username and password.
+## Using Bisq from a web browser (laptop/desktop only):
 
-**Note:** There is a black dot on the middle left part of the screen that is there for your convenience and has a Copy & Paste field, On Screen Keyboard, File Manager, and Fullscreen buttons.
+1. Launch the Bisq App by clicking on the **LAUNCH UI** button within Bisq. This will open Bisq in your default web browser.
+2. After launching the Bisq App, you will be prompted to enter the `abc` username and associated password.
 
-## Running Bisq using an RDP client:
+**Note:** Within the Bisq interface, you will find a black dot on the middle left part of the screen. This dot provides convenient features such as a Copy & Paste field, On-Screen Keyboard, File Manager, and Fullscreen buttons. **(During the login screen, the option to copy and paste is not available)**
 
-Please note that at this time, using an RDP client can only be used for Tor connections.
+## Using Bisq from an RDP client:
 
-1. Ensure that your RDP client can handle SOCKS5 proxy settings. We recommend [Parallels RAS](https://www.parallels.com/products/ras/download/client/) as a client for accessing the Bisq app through Tor.
-2. Connect to the .onion address provided by the Bisq > Interfaces through Parallels RAS.
-3. Log in with the username and password you set up during the configuration process.
+1. Ensure that your Remote Desktop Protocol (RDP) client can handle SOCKS5 proxy settings. We recommend using [Parallels RAS](https://www.parallels.com/products/ras/download/client/) for desktop and **RD Client** for mobile as clients for accessing the Bisq app through Tor.
+2. Connect to the .onion address provided by Bisq > Interfaces using an RDP client.
+3. Log in with the `abc` username and the associated password.
 
-## Using Bisq
+## Important notes
+
+The first time you use Bisq, you will be prompted to read and agree to the user agreement. Please take the time to review it.
+
+It may take a few moments for Bisq to open as it connects to the Tor network and syncs with Bisq's peer-to-peer trading network. Please be patient while the synchronization process completes.
 
-The first time Bisq is being used, you will be prompted to read and agree to the user agreement. It may take a few moments to open as it connects to the Tor network and syncs with Bisq's peer-to-peer trading network. Please be patient while the synchronization process completes.
-
 Once Bisq is fully synced, you are all set to start trading! If you have any questions or need help, you can refer to the Bisq documentation at https://bisq.wiki/.
 
-Happy and safe trading!
+Happy and safe trading!

manifest.yaml

@@ -4,7 +4,7 @@ title: "Bisq"
 version: 1.9.10
 release-notes: "We are thrilled to announce the initial release of Bisq version 1.9.10 for StartOS x86_64!"
 license: GPLv3
-wrapper-repo: "https://github.com/Start9Labs/bisq-wrapper"
+wrapper-repo: "https://github.com/Start9Labs/bisq-startos"
 upstream-repo: "https://github.com/bisq-network/bisq"
 support-site: "https://github.com/bisq-network/bisq/issues"
 marketing-site: "https://bisq.network"
@@ -36,8 +36,6 @@ config:
     type: script
   set:
     type: script
-properties:
-  type: script
 volumes:
   main:
     type: data
@@ -64,7 +62,7 @@ interfaces:
       - http
 dependencies:
   bitcoind:
-    version: ">=0.21.1.2 <26.0.0"
+    version: ">=0.21.1.2 <27.0.0"
     requirement:
       type: "opt-out"
       how: Internal bitcoind is used by default. Alternatively, Bisq's default list of nodes can be used.

scripts/embassy.ts

@@ -1,6 +1,5 @@
 export { setConfig } from "./procedures/setConfig.ts";
 export { getConfig } from "./procedures/getConfig.ts";
-export { properties } from "./procedures/properties.ts";
 export { dependencies } from "./procedures/dependencies.ts";
 export { migration } from "./procedures/migrations.ts";
 export { health } from "./procedures/healthChecks.ts";

scripts/procedures/getConfig.ts

@@ -12,18 +12,18 @@ export const getConfig = compat.getConfig({
     "masked": false,
     "copyable": true
   },
-  "auto_login": {
-    "name": "Automatic Login",
-    "description": "Enabling this feature will automatically log you in to Bisq without requiring you to enter your password.",
-    "type": "boolean",
-    "default": true
-  },
   "password": {
     "type": "string",
     "name": "Password",
     "description": "The password for logging into your Bisq as abc user",
     "nullable": false,
     "masked": true,
-    "default": "cba"
+    "default": {
+      charset: "a-z,1-9",
+      len: 10,
+    },
+    "pattern": "^[^\\n\"]*$",
+    "pattern-description": "Must not contain newline or quote characters.",
+    "copyable": true
   }
 })