Skip to content

Latest commit

 

History

History
139 lines (111 loc) · 3.99 KB

README.md

File metadata and controls

139 lines (111 loc) · 3.99 KB
Raw

Project Logo

Mutiny Wallet for StartOS

Mutiny Wallet is a lightning wallet that runs in the web. Unlike other lightning services on Start9, it is not a server that you run on StartOS. Instead, it is a web app that you can access from any device on your local network. This means that you can access your wallet from your phone, tablet, or laptop.

This repository creates the s9pk package that is installed to run Mutiny Wallet on StartOS. Learn more about service packaging in the Developer Docs.

Dependencies

Install the system dependencies below to build this project by following the instructions in the provided links. You can also find detailed steps to setup your environment in the service packaging documentation.

Build environment

Prepare your StartOS build environment. In this example we are using Ubuntu 20.04.

  1. Install docker
curl -fsSL https://get.docker.com | bash
sudo usermod -aG docker "$USER"
exec sudo su -l $USER
  1. Set buildx as the default builder
docker buildx install
docker buildx create --use
  1. Enable cross-arch emulated builds in docker
docker run --privileged --rm linuxkit/binfmt:v0.8
  1. Install yq
sudo snap install yq
  1. Install deno
sudo snap install deno
  1. Install essentials build packages
sudo apt-get install -y build-essential openssl libssl-dev libc6-dev clang libclang-dev ca-certificates
  1. Install Rust
curl https://sh.rustup.rs -sSf | sh
# Choose nr 1 (default install)
source $HOME/.cargo/env
  1. Build and install start-sdk
cd ~/ && git clone --recursive https://github.com/Start9Labs/start-os.git --branch sdk
cd start-os/backend/
./install-sdk.sh
start-sdk init

Now you are ready to build the mutiny package!

Cloning

Clone the project locally:

git clone https://github.com/MutinyWallet/mutiny-startos.git
cd mutiny-startos
git submodule update --init --recursive

Building

To build the mutiny package for all platforms using start-sdk, run the following command:

make

To build the mutiny package for a single platform using start-sdk, run:

# for amd64
make x86

or

# for arm64
make arm

Installing (on StartOS)

Run the following commands to determine successful install:

ℹ️ Change server-name.local to your Start9 server address

start-cli auth login
# Enter your StartOS password
start-cli --host https://server-name.local package install mutiny.s9pk

If you already have your start-cli config file setup with a default host, you can install simply by running:

make install

Tip: You can also install the mutiny.s9pk using Sideload Service under the System > Manage section.

Verify Install

Go to your StartOS Services page, select Mutiny, configure and start the service. Then, verify its interfaces are accessible.

Done!

Updating (for maintainers)

To update for a new release of mutiny-web, you'll need to update the mutiny-web submodule and the manifest.yaml and migrations.ts files.

  1. Update the mutiny-web submodule to the latest commit
cd mutiny-startos
git fetch --all
git checkout <tag of new release>
  1. Update the manifest.yaml and migrations.ts files to the new version
  2. Update release notes in manifest.yaml
  3. Commit changes
  4. Tag new release of mutiny-startos, this will trigger a new build of the mutiny-startos package in CI
git tag <tag of new release>
git push origin <tag of new release>