Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .env
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# .gitkeep
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout main
uses: actions/checkout@v4
uses: actions/checkout@v6

- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master
Expand Down
12 changes: 5 additions & 7 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Have a question that is not listed here? [Let us know!][contribute]
This FAQ compiles questions that relate to Jam in particular. For things related
to JoinMarket in general, please refer to the [JoinMarket documentation][jm-docs].

[jm-docs]: https://github.com/JoinMarket-Org/joinmarket-clientserver/tree/master/docs
[jm-docs]: https://github.com/joinmarket-ng/joinmarket-ng/blob/main/docs/index.md

### How much can I earn?

Expand Down Expand Up @@ -53,9 +53,9 @@ mempool or use a public site like [mempool.space][ms] to do a fee estimation.
It is recommended that you [run your own mempool.space
instance][ms-install] on your full node.

See also "[a note on fees][fee-note]" from the JoinMarket documentation.
See also "[Fees and safety][fee-note]" from the JoinMarket documentation.

[fee-note]: https://github.com/JoinMarket-Org/joinmarket-clientserver/blob/master/docs/tumblerguide.md#a-note-on-fees
[fee-note]: https://github.com/joinmarket-ng/joinmarket-ng/blob/main/docs/README-tumbler.md#fees-and-safety
[fees]: market/fees.md
[orderbook]: market/orderbook.md
[glossary]: glossary.md
Expand Down Expand Up @@ -129,7 +129,7 @@ it is always a good idea to inspect the log files for warning and error messages
### How do I view the log file?

If you are running Jam with one of the supported integrations (RaspiBlitz,
Citadel, Umbrel, etc.) chances are you can view the logs inside the app
Start9, Umbrel, etc.) chances are you can view the logs inside the app
(See Settings > Show logs).

If the option is not displayed, or if you run the `standalone` docker image
Expand Down Expand Up @@ -303,9 +303,7 @@ BerkeleyDB (BDB) wallet creation was deprecated in Bitcoin Core v26.0 which is n
_For now, the fix is to add `deprecatedrpc=create_bdb` to your bitcoin.conf file._

<details>
<summary>Step-by-step instructions on how to do this on Umbrel/Citadel</summary>
The example commands are for Umbrel, if you're using Citadel simply replace `umbrel` with `citadel`.
<br>
<summary>Step-by-step instructions on how to do this on Umbrel</summary>
<br>

1. Open the terminal and login to your node using ssh:
Expand Down
4 changes: 2 additions & 2 deletions docs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ and thus more easily accessible for more people.

## About JoinMarket

[JoinMarket][jmcs] is a special kind of software that is aimed at improving the privacy
[JoinMarket][jmng] is a special kind of software that is aimed at improving the privacy
and fungibility of bitcoin transactions. The main way to improve privacy and
fungibility on-chain is via collaborative transactions.

[jmcs]: https://github.com/JoinMarket-Org/joinmarket-clientserver
[jmng]: https://github.com/joinmarket-ng/joinmarket-ng

A collaborative transaction requires the coordination of multiple parties. The
right resources ([UTXOs][glossary]) have to be available in the right quantity
Expand Down
4 changes: 2 additions & 2 deletions docs/philosophy/00-motivation.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,13 +80,13 @@ written by Gigi and released under CC BY-SA 4.0 license."

## Why Jam?

Jam is a front-end for [JoinMarket][jmcs], a privacy-focused bitcoin software
Jam is a front-end for [JoinMarket][jmng], a privacy-focused bitcoin software
that uses a peer-to-peer marketplace to facilitate collaborative transactions,
also called "CoinJoins."[^fn-glossary]

[^fn-glossary]: We prefer to refer to them as [collaborative transactions](../glossary.md), which is more concise and explanatory.

[jmcs]: https://github.com/JoinMarket-Org/joinmarket-clientserver
[jmng]: https://github.com/joinmarket-ng/joinmarket-ng

A collaborative transaction, as the name implies, is a bitcoin transaction that
is done collaboratively by multiple parties. The tricky part of getting a
Expand Down
2 changes: 1 addition & 1 deletion docs/privacy/02-best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ both your privacy as well as your fee footprint.

Looking up addresses in public block explorers will link those addresses with
your IP, which, in turn, can be linked to your real identity. Software packages
like Umbrel, Citadel, RaspiBlitz, and BTCPay Server make it easy to run your own
like Umbrel, Start9, RaspiBlitz, and BTCPay Server make it easy to run your own
block explorer. If you have to use a public block explorer, make sure to mask
your IP by connecting to them via [Tor](https://www.torproject.org/download/),
or at least use a VPN.
Expand Down
14 changes: 0 additions & 14 deletions docs/software/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
Jam comes packaged with the following full-node solutions:

- [Umbrel](#with-umbrel)
- [Citadel](#with-citadel)
- [RaspiBlitz](#with-raspiblitz)
- [MyNode](#with-mynode)
- [Start9](#with-start9)
Expand Down Expand Up @@ -38,19 +37,6 @@ Jam can be installed directly from the [Umbrel](https://umbrel.com/) app store:
- Click install
- Done!

### ...with Citadel

Jam can be installed directly from the [Citadel](https://runcitadel.space/) app store:

- Open the interface of your Citadel node <br/> (type `citadel.local` in your browser)
- Find "Jam" in the Citadel app store
- Click install
- Done!

!!! info
If you are asked to enter a username and password after installation, enter
"citadel" as the username and the password that Citadel provides for you.

### ...with RaspiBlitz

Jam can be installed directly from the [Raspiblitz](https://github.com/raspiblitz/raspiblitz) WebUI since RaspiBlitz v1.9.0.
Expand Down
12 changes: 6 additions & 6 deletions docs/software/license.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# License

Both Jam and JoinMarket are released under free and open-source software licenses.
Both Jam and JoinMarket NG are released under free and open-source software licenses.

[:octicons-arrow-right-24: Philosophy: Free Software][free-software]

[free-software]: /philosophy/01-free-software

## Jam

Jam and is licensed under the [MIT License](https://directory.fsf.org/wiki/License:Expat).
Jam and is licensed under the [MIT License](https://mit-license.org).
The Jam documentation is licensed under the [GNU FDL](https://www.gnu.org/licenses/fdl-1.3.en.html).

- Jam [LICENSE](https://github.com/joinmarket-webui/jam/blob/master/LICENSE)
- JamDocs [LICENSE](https://github.com/joinmarket-webui/jamdocs/blob/master/LICENSE)
- Jam documentation [LICENSE](https://github.com/joinmarket-webui/jamdocs/blob/master/LICENSE)

---

## JoinMarket
## JoinMarket NG

JoinMarket is released under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html).
JoinMarket NG is released under the [MIT License](https://mit-license.org).

- JoinMarket [LICENSE](https://github.com/JoinMarket-Org/joinmarket-clientserver/blob/master/LICENSE)
- JoinMarket NG [LICENSE](https://github.com/joinmarket-ng/joinmarket-ng/blob/main/LICENSE)
46 changes: 46 additions & 0 deletions justfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# This justfile requires https://github.com/casey/just

# Load environment variables from `.env` file.
set dotenv-load
# Fail the script if the env file is not found.
set dotenv-required

project_dir := justfile_directory()

regtest_bitcoin_container_name := 'jam_docker_bitcoind'
regtest_bitcoin_container_rpcport := '43782'

# print available targets
[group("project-agnostic")]
default:
@just --list --justfile {{justfile()}}

# evaluate and print all just variables
[group("project-agnostic")]
evaluate:
@just --evaluate

# print system information such as OS and architecture
[group("project-agnostic")]
system-info:
@echo "architecture: {{arch()}}"
@echo "os: {{os()}}"
@echo "os family: {{os_family()}}"


[group("mkdocs")]
install:
pip install mkdocs
pip install mkdocs-material

[group("mkdocs")]
update:
pip install -U mkdocs

[group("mkdocs")]
serve:
mkdocs serve

[group("mkdocs")]
build:
mkdocs build
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ markdown_extensions:
- attr_list
- footnotes
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra_javascript:
- https://kit.fontawesome.com/090ca49637.js
Expand Down