Skip to content

Latest commit

 

History

History
131 lines (88 loc) · 6.99 KB

File metadata and controls

131 lines (88 loc) · 6.99 KB

Export and import a stack

Your compose file has things in it that belong only to you: passwords, keys, your own folder paths. Export makes a copy with those taken out. Your own stack is never touched.

1. Open the menu

Right-click a stack's row and choose Export…. See the stack list for the rest of that menu.

The stack menu open, with Export among its items

2. Choose what goes

The first screen lists every file in the stack's folder.

The first Export screen: a Files list showing the compose file always goes and a picture that is left behind because it cannot be checked, then Compose settings listing every setting with a tick box, the four already marked secret ticked for you

Kind What happens
Compose file Always goes. Cannot be unticked. Its settings can be blanked one at a time.
.env file Same as the compose file — names and values, so it can be blanked entry by entry.
Other text file Must be read on screen before it can be ticked. There is no safe way to blank one automatically.
Icon Ticked already, if the stack has one. Untick it to leave it out.
Refused Keys, certificates, anything not text, anything too large, folders, links. Listed with the reason. No tick.

A file the compose file actually needs is marked, so you can see what the other end depends on. That mark never turns a refused file into an allowed one.

Reading a file: lines that look like they carry something private are marked. This only ever means "look here". It never means the rest of the file is safe. The judgement stays with you.

Why keys are always refused. A private key is plain text, so the usual text check waves it through. StaXX checks the file's name and its first line instead — that second check still catches a key renamed to something else.

Blanking values

Below the file list is every setting in the compose file. Anything the file already marks as secret — see marking a value sensitive — is ticked for you. Paths start unticked; whether a folder name gives something away is your call.

Tick the .env file and its entries join the list, all ticked, since a .env exists to hold what differs machine to machine.

3. Check what is about to leave

Press Next. Nothing is written yet.

The second Export screen: Going lists the compose file, Left behind and why names the picture and the reason, Values blanked lists the four settings whose values are being replaced, and a line saying nothing is written until Export is pressed

Section Shows
Going Every file that will leave.
Left behind, and why Every file staying, with a reason.
Values blanked Every setting that will be replaced.

This screen also tells you one thing it does on your behalf: values you ticked get marked secret in your own stack too, so the next export already starts correct. It only marks compose settings — a .env file has nowhere to keep that mark.

4. Press Export

The bottom of the export summary: the line saying nothing is written until Export is pressed, then Cancel, Back and Export, with Export outlined

What you sent What you get
Just the compose file Downloads as plain text — paste it anywhere.
More than one file Downloads as a single .staxx file — an ordinary zip, rename it to .zip to look inside.

This is how you hand a stack over. The person who receives it can drop the file straight onto their own stack list to bring it in — see Opening one you receive below.

The exported file

The exported compose file as plain text: a comment block at the top saying which values were blanked, and further down a DEMO PASSWORD line reading REPLACE-ME

A blanked value becomes REPLACE-ME — never a value that looks real. StaXX refuses to start any stack still holding one, and says which settings are still waiting.

A note is written into the compose file itself, as comments at the top: what it is, when it was made, which stack it came from, every value blanked, every file left behind and why. No machine name, no username, no address. It rides inside the file because the usual way to send one of these is a paste into a chat, and a paste carries nothing but the text. Delete the note once nothing still reads REPLACE-ME.

Everything else survives untouched — comments, blank lines, the order you wrote it in. It is your real file with holes punched in it, not one rebuilt from scratch.

The person who receives it fills those holes in through the stack editor. For a value that needs a real password, see making a password or passphrase.

The icon

An icon lives in a hidden folder tucked inside the stack, alongside every earlier saved copy of the compose file — including the passwords those copies still hold. Export reaches into that folder for exactly one thing: the picture your compose file names. Nothing else in there ever leaves, by name, not by rule — there is no "everything except the risky bits" here.

What Export never does

  • It never changes the stack you are exporting, beyond marking ticked values as secret.
  • It never sends anything anywhere. It hands you a file; where it goes next is up to you.
  • It never includes a file you did not tick.
  • It never says a file is clean — only ever "look here".

Opening one you receive

The Import a bundle window after a drop: the folder it will land in, a Stack name box, the covering note listing what still needs filling in, and a What is inside list naming the compose file and a picture, with Cancel and Import buttons

Drag a .staxx file onto the stack list and drop it. Drop it on a folder to land there; drop it on a stack to join that stack's folder; drop it anywhere else to land at the top level.

Nothing is written on drop. You get a preview first — what it holds, where it will land, what it will be called, and the sender's note listing every value to fill in. Press Import and the stack appears, stopped, still holding its REPLACE-ME values.

If the name is taken, StaXX asks for another. It never merges into or overwrites an existing stack. Every part of a bundle is checked before anything is unpacked; a bundle with anything outside the shapes StaXX allows is refused, with a reason. Nothing in it can reach outside the new stack's own folder, and nothing it claims about its own past is believed.

Prefer to do it by hand? Make a new stack and paste the compose text in.

Terms used here

Any word you are not sure of is in the glossary.

Back to the StaXX guide.