Skip to content

Commit ef62910

Browse files
authored
Frankenwallet (SPO & Builder tool): Update URL + doc cleanup (#1475)
* change cosd.com/frankenwallet to frankenwallet.com + pandoc cleanup * updated title for Hardware Wallets page * old "templates" are replaced by a more general Transaction Flow
1 parent 990e7ce commit ef62910

File tree

3 files changed

+24
-24
lines changed

3 files changed

+24
-24
lines changed

docs/get-started/air-gap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ If this appeals to you, and you don't mind following a more complicated and erro
298298

299299
This loosely documented configuration has been called the **Frankenwallet**, with separate instructions at these links which mostly follow the procedure above:
300300

301-
- **[The Frankenwallet](https://cosd.com/frankenwallet)** - detailed external web site, including semantics for using your bootable USB environment in secure & blockchain workflow
301+
- **[The Frankenwallet](https://frankenwallet.com)** - detailed external web site, including semantics for using your bootable USB environment in secure & blockchain workflow
302302
- [Get Started with the Frankenwallet](/docs/operate-a-stake-pool/frankenwallet.md) - one-page summary here on the Developer Portal
303303

304304
:::warning

docs/operate-a-stake-pool/frankenwallet.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ Operators needing a safer path can follow instructions at the [Air Gap Environme
2525

2626
### How to use this guide
2727

28-
This tool has been developed by the [COSD stake pool](https://cexplorer.io/pool/pool1e98xlcgj80c3rdmm27v5hnvrdtut52e65uk0ema7ctfag596vr2), beginning as a publication of their own operating environment when scared to death of losing their pool pledge and not being able to come by a second machine for the conventional [air gap environment](/docs/get-started/air-gap) (see origin story: [Why was the Frankenwallet developed?](https://cosd.com/frankenwallet/intro/history)).
28+
This tool has been developed by the [COSD stake pool](https://cexplorer.io/pool/pool1e98xlcgj80c3rdmm27v5hnvrdtut52e65uk0ema7ctfag596vr2), beginning as a publication of their own operating environment when scared to death of losing their pool pledge and not being able to come by a second machine for the conventional [air gap environment](/docs/get-started/air-gap) (see origin story: [Why was the Frankenwallet developed?](https://frankenwallet.com/intro/history)).
2929

3030
At the time of this writing, the full instructions for:
3131

3232
- the reasons you would want to use this tool
3333
- how to provision & build your own Frankenwallet
3434
- how to use the tool for stake pool operations & secure transactions
3535

36-
… are in the online book at this external link: [The Frankenwallet](https://cosd.com/frankenwallet).  If you see any problems with this material, please submit an issue at:
36+
… are in the online book at this external link: [The Frankenwallet](https://frankenwallet.com).  If you see any problems with this material, please submit an issue at:
3737

3838
- [github:rphair/frankenwallet](https://github.com/rphair/frankenwallet) if you find an error in the material in the externally linked web site
3939
- [github:cardano-foundation/developer-portal](https://github.com/cardano-foundation/developer-portal) with any updates or corrections to this page itself.
@@ -44,7 +44,7 @@ This is a one-page summary of those external instructions to help you (the opera
4444

4545
➤ Anyone working with private keys & [secure transaction signing](/docs/get-started/secure-workflow), seed phrases, or other high value resources targeted by hackers (e.g., [stake pool keys](/docs/operate-a-stake-pool/cardano-key-pairs)).
4646

47-
➤ Anyone wishing to work in high security with these resources without either a second computer (e.g. perpetual travellers, students, and hardware minimalists) or a hardware wallet ([Why wouldn't I want a hardware wallet?](https://cosd.com/frankenwallet/intro/hardware-wallets))
47+
➤ Anyone wishing to work in high security with these resources without either a second computer (e.g. perpetual travellers, students, and hardware minimalists) or a hardware wallet ([Frankenwallet vs. Hardware wallets](https://frankenwallet.com/intro/hardware-wallets))
4848

4949
➤ Anyone wanting or needing direct access to all their own files on their main computer in the air-gapped environment.
5050

@@ -56,13 +56,13 @@ This is a one-page summary of those external instructions to help you (the opera
5656

5757
### If so universally useful, why the build instructions & not just a downloadable ISO image?
5858

59-
**TL;DR** because then all Frankenwallets would be the same, and any security flaw found in one of them might allow all of them to be exploited before a response could be mounted (see [Why is there no ISO image for Frankenwallet?](https://cosd.com/frankenwallet/intro/no-iso)).
59+
**TL;DR** because then all Frankenwallets would be the same, and any security flaw found in one of them might allow all of them to be exploited before a response could be mounted (see [Why is there no ISO image for Frankenwallet?](https://frankenwallet.com/intro/no-iso)).
6060

6161
### Some other use cases & limitations of this material
6262

6363
➤ You *can* use the Frankenwallet instructions to set up an Air Gap node on a full computer… but since the time of its development, this procedure has been adapted to a more appropriate page on the Dev Portal (the aforementioned [Air Gap Environment](/docs/get-started/air-gap)).
6464

65-
From [Frankenwallet \> Miscellaneous FAQ's](https://cosd.com/frankenwallet/intro/faq):
65+
From [Frankenwallet > Miscellaneous FAQ's](https://frankenwallet.com/intro/faq):
6666

6767
➤ Your VirtualBox or other VM software on your host computer *does not* isolate you from the network, even if you have the network device disabled… nor can it be ever assumed that the screen or keyboard are isolated either… so VMs are generally unsuitable to create an air gap *<span class="underline">or</span>* to implement these instructions.
6868

@@ -72,7 +72,7 @@ From [Frankenwallet \> Miscellaneous FAQ's](https://cosd.com/frankenwallet/intro
7272

7373
## Preparing to build the Frankenwallet
7474

75-
From [Frankenwallet \> Preparation](https://cosd.com/frankenwallet/prepare):
75+
From [Frankenwallet > Preparation](https://frankenwallet.com/prepare):
7676

7777
#### Planning your communication with the host computer
7878

@@ -95,15 +95,15 @@ Though regularly used Frankenwallets have been built on cheap & slow USB drives,
9595

9696
Users who have built dual-boot configurations before will also know you should **familiarise yourself with the computer's BIOS settings** in anticipation of the same type of setup.
9797

98-
Note there are <span class="underline">limitations about using a Mac</span> as host computer which stem from the different means of booting (see [Frankenwallet \> Hardware Requirements](https://cosd.com/frankenwallet/prepare/hardware) \> What if I have a Mac?).
98+
Note there are <span class="underline">limitations about using a Mac</span> as host computer which stem from the different means of booting (see [Frankenwallet > Hardware Requirements](https://frankenwallet.com/prepare/hardware) > What if I have a Mac?).
9999

100100
### Choosing passwords
101101

102-
(from Frankenwallet passwords \> [low security](https://cosd.com/frankenwallet/prepare/password-low) & [high security](https://cosd.com/frankenwallet/prepare/password-high))
102+
(from Frankenwallet passwords > [low security](https://frankenwallet.com/prepare/password-low) & [high security](https://frankenwallet.com/prepare/password-high))
103103

104-
The [low security password](https://cosd.com/frankenwallet/prepare/password-low) can be one you've already used to encrypt files on the host computer… strong enough you feel comfortable backing up files over the net.
104+
The [low security password](https://frankenwallet.com/prepare/password-low) can be one you've already used to encrypt files on the host computer… strong enough you feel comfortable backing up files over the net.
105105

106-
The [high security password](https://cosd.com/frankenwallet/prepare/password-high)… called the Frankenwallet password itself… should also be strictly long & complex, but should never have been used in a network environment, not even on a network connected machine… otherwise you will be defeating the purpose of using the Air Gap for any purposes of file storage or backup of files to the host computer
106+
The [high security password](https://frankenwallet.com/prepare/password-high)… called the Frankenwallet password itself… should also be strictly long & complex, but should never have been used in a network environment, not even on a network connected machine… otherwise you will be defeating the purpose of using the Air Gap for any purposes of file storage or backup of files to the host computer
107107

108108
See each of these web links to see which of the Cardano asset & stake pool files it would typically be used to encrypt.
109109

@@ -121,7 +121,7 @@ For ease of use, you can separate the "low security" and "high security" stake p
121121

122122
## Installing the OS onto the USB device
123123

124-
(from [Frankenwallet \> Host computer & media](https://cosd.com/frankenwallet/prepare/computer) though end of [Installation](https://cosd.com/frankenwallet/install) section)
124+
(from [Frankenwallet > Host computer & media](https://frankenwallet.com/prepare/computer) though end of [Installation](https://frankenwallet.com/install) section)
125125

126126
The full instructions mainly document the [installation of Ubuntu](https://ubuntu.com/tutorials/install-ubuntu-desktop#1-overview) in the common "dual boot" configuration: something the target audience should feel comfortable with, and can probably improvise for themselves if also following these checklists during the installation & setup or the installed environment:
127127

@@ -147,18 +147,18 @@ Note the password you chose will be required now to boot the OS as well as decry
147147

148148
:::warning warning
149149

150-
At the next screen Erase disk and install Ubuntu, watch out that you don't accidentally select your computer's own drive… this can be very easy to do\!
150+
At the next screen Erase disk and install Ubuntu, watch out that you don't accidentally select your computer's own drive… this can be very easy to do!
151151

152152
:::
153153

154154
### Setup notes: operating system
155155

156156
- Don't let Ubuntu link with any online accounts in its initialisation process: refuse everything like location services, "livepatch", etc.
157-
- Disable lots of little services & settings which might leak your information (see [Frankenwallet \> First boot: Secure system settings](https://cosd.com/frankenwallet/install/settings))
157+
- Disable lots of little services & settings which might leak your information (see [Frankenwallet > First boot: Secure system settings](https://frankenwallet.com/install/settings))
158158

159159
### Setup notes: packages
160160

161-
(details: [Frankenwallet \> First boot: Package installation](https://cosd.com/frankenwallet/install/packages))
161+
(details: [Frankenwallet > First boot: Package installation](https://frankenwallet.com/install/packages))
162162

163163
- Remove all "snaps" and disable Snap.
164164
- Remove CUPS (network printer service).
@@ -173,13 +173,13 @@ At the next screen Erase disk and install Ubuntu, watch out that you don't accid
173173

174174
### Tune browser & turn off network access FOREVER
175175

176-
Lock down the browser settings, just in case, even if you think you'll never use it ([Frankenwallet \> Securing Firefox browser](https://cosd.com/frankenwallet/install/browser))
176+
Lock down the browser settings, just in case, even if you think you'll never use it ([Frankenwallet > Securing Firefox browser](https://frankenwallet.com/install/browser))
177177

178178
At this point you disable Wi-Fi and all other networks in the system settings, and go on without any future connection to the Internet in your new environment.
179179

180180
## What to use the Frankenwallet for
181181

182-
From a growing body of material beginning at [Frankenwallet \> Usage](https://cosd.com/frankenwallet/usage):
182+
From a growing body of material beginning at [Frankenwallet > Usage](https://frankenwallet.com/usage):
183183

184184
### Prepare and submit secure transactions
185185

@@ -192,28 +192,28 @@ You can now follow the instructions recommended in [Secure Transaction Workflow]
192192
- Save the resulting transaction file to your Host Folder.
193193
- Reboot into the host computer, upload your transaction file if necessary, and submit it.
194194

195-
Some copy-paste models & templates for basic Cardano transactions are being assembled here: [Frankenwallet \> Transaction templates](https://cosd.com/frankenwallet/cardano/templates)
195+
This means of implementing the [Secure Transaction Workflow](/docs/get-started/secure-workflow) process is outlined specifically in [Frankenwallet > Transaction flow](https://frankenwallet.com/cardano/model).
196196

197197
### Making & verifying backups of assets & keys
198198

199-
from [Frankenwallet \> Backups to host machine](https://cosd.com/frankenwallet/usage/backups):
199+
from [Frankenwallet > Backups to host machine](https://frankenwallet.com/usage/backups):
200200

201-
For [highly secure stake pool & asset files](https://cosd.com/frankenwallet/prepare/password-high), and any documents storing wallet key phrases or raw private key data:
201+
For [highly secure stake pool & asset files](https://frankenwallet.com/prepare/password-high), and any documents storing wallet key phrases or raw private key data:
202202

203203
- First create the file archive (with 7z) or text document (with LibreOffice) using your "high security" password.
204204
- Then copy it to your host folder, where it can remain stored or backed up (over the network if desired) along with all your other computer's data.
205205
- This is safe (pending the usual arguments) because **you never have entered, and never will enter, the Frankenwallet (high security) password on your host computer <span class="underline">or</span> any other machine**.
206-
- This means you can only verify these backups on this or another Frankenwallet… never on the host computer environment itself\!
206+
- This means you can only verify these backups on this or another Frankenwallet… never on the host computer environment itself!
207207

208-
For [less secure stake pool & asset files](https://cosd.com/frankenwallet/prepare/password-low), and documents with general transaction records & source data:
208+
For [less secure stake pool & asset files](https://frankenwallet.com/prepare/password-low), and documents with general transaction records & source data:
209209

210210
- First create the file archive (with 7z) or text document (with LibreOffice) using your "high security" password.
211211
- These files you might feel comfortable verifying on your host computer.
212212
- NOTE for less urgently secure stake pool pool files (e.g. verification keys, operational certificate counters) you might provide a second dedicated password… with "security level" between your general encryption password and the "high security" password… which you only use for the purposes of your assets & stake pool public keys.
213213

214214
### The "cool" Frankenwallet: a sandbox for crypto wallets
215215

216-
from [Frankenwallet \> Cool environments](https://cosd.com/frankenwallet/cool):
216+
from [Frankenwallet > Cool environments](https://frankenwallet.com/cool):
217217

218218
Relaxing the Internet environment (meaning **this device should no longer be used for cold, unencrypted key storage**) allows you to use this device for node- or browser-based wallets.
219219

src/data/builder-tools.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -876,7 +876,7 @@ export const Showcases = [
876876
title: "Frankenwallet",
877877
description: "An encrypted, air-gapped Linux bootable USB drive for Cardano transaction signing, sandboxed access to files on your main computer, and storage & backup of secure assets & documents.",
878878
preview: require("./builder-tools/frankenwallet.png"),
879-
website: "https://cosd.com/frankenwallet",
879+
website: "https://frankenwallet.com",
880880
getstarted: "/docs/operate-a-stake-pool/frankenwallet",
881881
tags: ["operatortool"],
882882
},

0 commit comments

Comments
 (0)