The Onion Services Ecosystem

https://onionservices.torproject.org/
Admin
This Onion Services Ecosystem Documentation aggregates content from many projects into a single...
Tokens:208,461
Snippets:2,286
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Setup Virtualenv and Install Onionprobe from Source

Source: https://onionservices.torproject.org/apps/web/onionprobe/installation

Installs pip, Tor, sets up a virtual environment, and then installs Onionprobe from the source code within that environment.

```bash
sudo apt install -y python3-pip tor
python3 -m venv venv
source venv/bin/activate
pip3 install .
```

--------------------------------

### Setup Virtual Environment for Onionprobe

Source: https://onionservices.torproject.org/apps/web/onionprobe/installation

Creates a directory, sets up a Python virtual environment, and activates it for installing Onionprobe.

```bash
mkdir onionprobe
cd onionprobe
python3 -m venv venv
source venv/bin/activate
```

--------------------------------

### Manual Environment Setup and Server

Source: https://onionservices.torproject.org/apps/web/onion-launchpad/build

Sets up a virtual environment, sources environment variables, cleans the build, and starts the Lektor server. The `lektor-venv` function handles virtual environment creation and activation.

```bash
lektor-venv && source .env && lektor clean --yes && lektor server

```

--------------------------------

### Setup Virtualenv and Install Onionbalance with pip

Source: https://onionservices.torproject.org/apps/base/onionbalance/installation

Creates a virtual environment, activates it, and installs Onionbalance using pip. The created folder can host configuration and data.

```bash
mkdir onionbalance
cd onionbalance
python3 -m venv venv
source venv/bin/activate
pip install onionbalance

```

--------------------------------

### Example Softmap Configuration File

Source: https://onionservices.torproject.org/apps/web/onionspray/guides/balance/softmaps

Displays the beginning of an example configuration file for softmaps in Onionspray.

```conf
# -*- conf -*-
```

--------------------------------

### Install from PyPI

Source: https://onionservices.torproject.org/apps/base/onionbalance/development

Install the final package from PyPI in a fresh virtual machine for final verification.

```shell
sudo apt-get install -y python3-pip tor
pip install --break-system-packages \
  onionbalance==$ONIONBALANCE_VERSION
```

--------------------------------

### Onionspray Start Project Command

Source: https://onionservices.torproject.org/apps/web/onionspray/guides/syntax

Starts specified projects or all projects.

```bash
onionspray start projectname ...

```

```bash
onionspray -a

```

--------------------------------

### Install from Test PyPI

Source: https://onionservices.torproject.org/apps/base/onionbalance/development

Install the package from Test PyPI in a new virtual machine to verify.

```shell
sudo apt-get install -y python3-pip tor
pip install -i https://pypi.org/simple/ \
            --extra-index-url https://test.pypi.org/simple \
            --break-system-packages \
            onionbalance==$ONIONBALANCE_VERSION
```

--------------------------------

### Start Onionspray Demo

Source: https://onionservices.torproject.org/apps/web/onionspray/guides/demo

Start the Onionspray demo for the specified service (e.g., 'wikipedia').

```bash
./onionspray start wikipedia
```

--------------------------------

### Consolidating Services in a Single Project

Source: https://onionservices.torproject.org/apps/web/onionspray/guides/balance/hardmaps

This example demonstrates a less optimal setup where all Onion Services are configured within a single Onionspray project (project1). This results in a single Tor and NGINX instance, potentially leading to poorer load balancing compared to distributing services across multiple projects.

```bash
user@onionspray:/home/user/onionspray$ grep hardmap *.conf
project1.conf:hardmap obep6i4wljp2atxkbjkeq7ycvhqa7eabs4rbocfut54wxer44bkfhqyd example.org
project1.conf:hardmap 3g4ul3iy55bkbjlesn26nj2oocsgot2mp63cintnyk4jshbhqtpofpid example.net
project1.conf:hardmap vnbuts3d3vfjjrgknxkma2wuyifwgs27qfkasm2h45zap7msamxwload somedomain.org
project1.conf:hardmap 3ln46qs2g7wzv75kjjc3r4ia5jv2mrojjdgby2vcdtsr3cswhg3l7xqd someotherdomain.com
project1.conf:hardmap 66yaevkgze2sxcetn45ynkp76rpgsuqg22hw2bj33qpc5plklmay2cyd anothersite.org
project1.conf:hardmap odxuyg67aqpedgjt5qxexnuixve3ule7o45yjubdbd3onqvlmzwzikad etcetctc.org
project1.conf:hardmap gwi5cpyyci4xlvgczchcyq353hukjdsgvthtaebqyqlmftds7ioprwyd thelistgoeson.org
project1.conf:hardmap 7zsdpgioajonm556fqgjts6huqcr3dc7ofvigl7sofzggnp6jq5ie5yd andonaonaon.org
project1.conf:hardmap zppyz4ta6en6x5z25zy5fztvuds4khrwcuvdveumhikzhbzpwsm3u7ad andsoandso.org
```

--------------------------------

### Install Python Pip and Clone Onionprobe Repository

Source: https://onionservices.torproject.org/apps/web/onionprobe/installation

Installs the python3-pip package and clones the Onionprobe Git repository. This is the first step for installing from source.

```bash
sudo apt install -y python3-pip
git clone https://gitlab.torproject.org/tpo/onion-services/onionbalance
cd onionprobe
```

--------------------------------

### Start Onionbalance Service

Source: https://onionservices.torproject.org/apps/base/onionbalance/man/onionbalance

Use this command to start the Onionbalance service using systemd or init scripts. This is an alternative to starting the management server directly.

```bash
$ sudo service onionbalance start

```

--------------------------------

### Install Git on FreeBSD

Source: https://onionservices.torproject.org/apps/web/onionspray/guides/installation

Installs Git on FreeBSD using pkg. This is a prerequisite for cloning the Onionspray repository.

```bash
pkg install git
```

--------------------------------

### Start All Onion Services

Source: https://onionservices.torproject.org/apps/web/onionspray/guides/balance/hardmaps

Starts all configured Onion Service instances simultaneously.

```bash
./onionspray start -a

```

--------------------------------

### Install Onionprobe Package Locally

Source: https://onionservices.torproject.org/apps/web/onionprobe/development

Install the built Python package in a fresh virtual machine for testing.

```shell
sudo apt-get install -y python3-pip tor
pip install --break-system-packages \
  dist/onionprobe-$ONIONPROBE_VERSION-*.whl
```

--------------------------------

### Install Onionbalance Package in VM

Source: https://onionservices.torproject.org/apps/base/onionbalance/development

Install the built Python package in a fresh virtual machine.

```shell
sudo apt-get install -y python3-pip tor
pip install --break-system-packages \
  dist/onionbalance-$ONIONBALANCE_VERSION-*.whl
```

--------------------------------

### Onionspray Onionbalance Start Command

Source: https://onionservices.torproject.org/apps/web/onionspray/guides/syntax

Starts Onionbalance for specified projects or all applicable projects.

```bash
onionspray ob-start projectname ...

```

```bash
onionspray -a, if applicable

```

--------------------------------

### Install Onionprobe from Test PyPI

Source: https://onionservices.torproject.org/apps/web/onionprobe/development

Install the Onionprobe package from Test PyPI in a new virtual machine for further testing.

```shell
sudo apt-get install -y python3-pip tor
pip install -i https://pypi.org/simple/ \
            --extra-index-url https://test.pypi.org/simple \
            --break-system-packages \
            onionprobe==$ONIONPROBE_VERSION
```

--------------------------------

### Install Onionprobe from PyPI

Source: https://onionservices.torproject.org/apps/web/onionprobe/development

Install the final Onionprobe package from PyPI in a new virtual machine for final verification.

```shell
sudo apt-get install -y python3-pip tor
pip install --break-system-packages \
  onionprobe==$ONIONPROBE_VERSION
```

--------------------------------

### Install Tor (Debian-based)

Source: https://onionservices.torproject.org/apps/base/onionbalance/tutorial

Installs a pre-compiled Tor daemon binary on Debian-like systems using apt.

```bash
sudo apt install tor

```

--------------------------------

### Start All Onionspray Projects

Source: https://onionservices.torproject.org/apps/web/onionspray/guides/using

Starts all configured Onionspray projects simultaneously. Use this for managing multiple projects efficiently.

```bash
./onionspray start -a
```

--------------------------------

### Install Git on Debian-based Systems

Source: https://onionservices.torproject.org/apps/web/onionspray/guides/installation

Installs Git on Debian-based systems using apt. This is a prerequisite for cloning the Onionspray repository.

```bash
sudo apt install git
```

--------------------------------

### Start Onionspray Server

Source: https://onionservices.torproject.org/apps/web/onionspray/tutorial

Start the Onionspray server for a specific project. Ensure the project name is correctly provided.

```bash
./onionspray start myproject

```

--------------------------------

### Provision and Build with PyEnv

Source: https://onionservices.torproject.org/apps/web/onion-launchpad/build

Sets up the environment using PyEnv and then builds the landing page. Assumes `scripts/provision` has already been run.

```bash
scripts/provision-pyenv

```

```bash
scripts/build

```

--------------------------------

### Get Start Time of Current SRV Run

Source: https://onionservices.torproject.org/apps/base/onionbalance/api

Returns the start time of the current SR protocol run.

```python
def get_start_time_of_current_srv_run(self):
        """
        Return the start time of the current SR protocol run using the times from

```

--------------------------------

### Get All Introduction Points for Publishing

Source: https://onionservices.torproject.org/apps/base/onionbalance/api

Retrieves all introduction points from all instances of a service, returning an IntroductionPointSetV3. It handles cases where an instance might be missing a descriptor or is offline.

```python
def get_all_intros_for_publish(self):
    """
    Return an IntroductionPointSetV3 with all the intros of all the instances
    of this service.
    """
    all_intros = []

    for instance in self.instances:
        try:
            instance_intros = instance.get_intros_for_publish()
        except onionbalance.hs_v3.instance.InstanceHasNoDescriptor:
            logger.info("Entirely missing a descriptor for instance %s. Continuing anyway if possible",
                        instance.onion_address)
            continue
        except onionbalance.hs_v3.instance.InstanceIsOffline:
            logger.info("Instance %s is offline. Ignoring its intro points...",
                        instance.onion_address)
            continue

        all_intros.append(instance_intros)

    return descriptor.IntroductionPointSetV3(all_intros)
```

--------------------------------

### Test Onionprobe Installation

Source: https://onionservices.torproject.org/apps/web/onionprobe/development

Test the installed Onionprobe package by checking its version and running it with example onion service addresses.

```shell
$HOME/.local/bin/onionprobe --version
$HOME/.local/bin/onionprobe -e \
  http://2gzyxa5ihm7nsggfxnu52rck2vv4rvmdlkiu3zzui5du4xyclen53wid.onion
$HOME/.local/bin/onionprobe -e \
  https://v236xhqtyullodhf26szyjepvkbv6iitrhjgrqj4avaoukebkk6n6syd.onion
```

--------------------------------

### Starting Onionbalance Service

Source: https://onionservices.torproject.org/apps/base/onionbalance/tutorial

Command to start the Onionbalance service. Ensure the control port (6666 in this example) matches your Tor `torrc` configuration.

```bash
onionbalance -v info -c config/config.yaml -p 6666

```

--------------------------------

### Copy Softmap Example Configuration

Source: https://onionservices.torproject.org/apps/web/onionspray/guides/balance/softmaps

Copy the example softmap configuration file to create your site-specific configuration. This file should then be edited to match your needs.

```bash
cp examples/softexample.tconf site.tconf # and edit to your needs
```

--------------------------------

### Get All Introduction Points for Publishing

Source: https://onionservices.torproject.org/apps/base/onionbalance/api

Aggregates introduction points from all instances of the service. It handles cases where an instance might be missing a descriptor or is offline, logging these issues and continuing if possible.

```python
all_intros = []

        for instance in self.instances:
            try:
                instance_intros = instance.get_intros_for_publish()
            except onionbalance.hs_v3.instance.InstanceHasNoDescriptor:
                logger.info("Entirely missing a descriptor for instance %s. Continuing anyway if possible",
                            instance.onion_address)
                continue
            except onionbalance.hs_v3.instance.InstanceIsOffline:
                logger.info("Instance %s is offline. Ignoring its intro points...",
                            instance.onion_address)
                continue

            all_intros.append(instance_intros)

        return descriptor.IntroductionPointSetV3(all_intros)
```

--------------------------------

### Get Start Time of Previous SRV Run

Source: https://onionservices.torproject.org/apps/base/onionbalance/api

Calculates the start time of the previous Server Rotation (SR) protocol run. It uses the current SRV run's start time and subtracts the duration of a full SR protocol run (24 intervals).

```python
    def get_start_time_of_previous_srv_run(self):
        from onionbalance.hs_v3.onionbalance import my_onionbalance

        start_time_of_current_run = self.get_start_time_of_current_srv_run()
        if my_onionbalance.is_testnet:
            return start_time_of_current_run - 24 * 20
        else:
            return start_time_of_current_run - 24 * 3600
```

--------------------------------

### Clone Oniongroove Repository

Source: https://onionservices.torproject.org/apps/web/oniongroove/prototype

Use this command to get the Oniongroove codebase along with its submodules. Ensure you have Git installed.

```bash
git clone --recursive https://gitlab.torproject.org/tpo/onion-services/oniongroove.git
```

--------------------------------

### Choose Introduction Points

Source: https://onionservices.torproject.org/apps/base/onionbalance/api

Retrieves a specified number of introduction points from a set of available IPs. If more IPs are available than requested, it selects them to maximize distribution across backend instances. Shuffles the selected points if shuffle is True.

```python
def choose(self, count=10, shuffle=True):
    """
    [Public API]

    Retrieve N introduction points from the set of IPs

    Where more than `count` IPs are available, introduction points are
    selected to try and achieve the greatest distribution of introduction
    points across all of the available backend instances.

    Return a list of IntroductionPoints.
    """

    # Limit `count` to the available number of IPs to avoid repeats.
    count = min(len(self), count)
    choosen_ips = list(itertools.islice(self._intro_point_generator, count))

    if shuffle:
        random.shuffle(choosen_ips)
    return choosen_ips
```

--------------------------------

### Get Start Time of Next Time Period

Source: https://onionservices.torproject.org/apps/base/onionbalance/api

Calculates and returns the start time of the upcoming time period. It considers the time period length, the next time period number, and the SRV phase rotation offset.

```python
def get_start_time_of_next_time_period(self, valid_after=None):
    """
    Return the start time of the upcoming time period
    """
    assert (self.is_live())

    # Get start time of next time period
    time_period_length = self.get_time_period_length()
    next_time_period_num = self.get_next_time_period_num(valid_after)
    start_of_next_tp_in_mins = next_time_period_num * time_period_length

    # Apply rotation offset as specified by prop224 section [TIME-PERIODS]
    time_period_rotation_offset = self._get_srv_phase_duration()

    return (start_of_next_tp_in_mins + time_period_rotation_offset) * 60
```

--------------------------------

### Get Start Time of Next Time Period

Source: https://onionservices.torproject.org/apps/base/onionbalance/api

Calculates the start time of the upcoming time period. It considers the time period length, the next time period number, and applies a rotation offset as specified by prop224.

```python
    def get_start_time_of_next_time_period(self, valid_after=None):
        """
        Return the start time of the upcoming time period
        """
        assert (self.is_live())

        # Get start time of next time period
        time_period_length = self.get_time_period_length()
        next_time_period_num = self.get_next_time_period_num(valid_after)
        start_of_next_tp_in_mins = next_time_period_num * time_period_length

        # Apply rotation offset as specified by prop224 section [TIME-PERIODS]
        time_period_rotation_offset = self._get_srv_phase_duration()

        return (start_of_next_tp_in_mins + time_period_rotation_offset) * 60
```

--------------------------------

### Start Oniongroove with Configuration

Source: https://onionservices.torproject.org/apps/web/oniongroove/prototype

Initiate the Oniongroove service by providing the path to your custom configuration file. This command starts the prototype with your specified settings.

```bash
./oniongroove start configs/myprovider.yaml
```

--------------------------------

### Add GitHub Configuration File

Source: https://onionservices.torproject.org/apps/web/onion-launchpad/deploy

Copies a sample GitHub configuration file for Onion Launchpad. Ensure the source path is correct and the destination is appropriate for your setup.

```bash
cp /path/to/onion-launchpad/configs/deploy/onion-launchpad-test.github.io.ini \
   gitlab/$somesite.github.io.ini
```

--------------------------------

### Get Start Time of Current SRV Run

Source: https://onionservices.torproject.org/apps/base/onionbalance/api

Calculates the start time of the current Server Rotation (SR) protocol run based on the consensus's valid-after time. It accounts for different voting intervals in testnet and real networks.

```python
    def get_start_time_of_current_srv_run(self):
        from onionbalance.hs_v3.onionbalance import my_onionbalance

        assert (self.is_live())

        beginning_of_current_round = stem.util.datetime_to_unix(self.consensus.valid_after)

        # Voting interval is 20 secs in chutney and one hour in real network
        if my_onionbalance.is_testnet:
            voting_interval_secs = 20
        else:
            voting_interval_secs = 60 * 60

        # Get current SR protocol round (an SR protocol run has 24 rounds)
        curr_round_slot = (beginning_of_current_round // voting_interval_secs) % 24
        time_elapsed_since_start_of_run = curr_round_slot * voting_interval_secs

        logger.debug("Current SRV proto run: Start of current round: %s. "
                     "Time elapsed: %s (%s)", beginning_of_current_round,
                     time_elapsed_since_start_of_run, voting_interval_secs)

        return int(beginning_of_current_round - time_elapsed_since_start_of_run)
```

--------------------------------

### Get Start Time of Current SRV Run

Source: https://onionservices.torproject.org/apps/base/onionbalance/api

Calculates and returns the start time of the current SR protocol run based on consensus times. It accounts for testnet vs. real network voting intervals and SR protocol run durations.

```python
def get_start_time_of_current_srv_run(self):
    """
    Return the start time of the current SR protocol run using the times from
    the current consensus. For example, if the latest consensus valid-after is
    23/06/2017 23:00:00 and a full SR protocol run is 24 hours, this function
    returns 23/06/2017 00:00:00.

    TODO: unittest
    """
    from onionbalance.hs_v3.onionbalance import my_onionbalance

    assert (self.is_live())

    beginning_of_current_round = stem.util.datetime_to_unix(self.consensus.valid_after)

    # Voting interval is 20 secs in chutney and one hour in real network
    if my_onionbalance.is_testnet:
        voting_interval_secs = 20
    else:
        voting_interval_secs = 60 * 60

    # Get current SR protocol round (an SR protocol run has 24 rounds)
    curr_round_slot = (beginning_of_current_round // voting_interval_secs) % 24
    time_elapsed_since_start_of_run = curr_round_slot * voting_interval_secs

    logger.debug("Current SRV proto run: Start of current round: %s. "
                 "Time elapsed: %s (%s)", beginning_of_current_round,
                 time_elapsed_since_start_of_run, voting_interval_secs)

    return int(beginning_of_current_round - time_elapsed_since_start_of_run)
```

--------------------------------

### Lektor Virtual Environment Setup Function

Source: https://onionservices.torproject.org/apps/web/onion-launchpad/build

A bash function to create and activate a Python virtual environment for the Onion Launchpad project. It installs `pip` and `lektor` if the environment doesn't exist.

```bash
lektor-venv () 
{
    VENV="${VENV:-$HOME/.virtualenvs/onion-launchpad}"

    [ -d "$VENV" ] && source "$VENV/bin/activate" && \
      echo 'virtualenv found in "$VENV" and activated' && return;

    python3.8 -m venv "$VENV" && source "$VENV/bin/activate" && \
      pip install --upgrade pip lektor && echo 'virtualenv set up in "$VENV" and activated'
}

```

--------------------------------

### Set up Easy-RSA for Custom CA

Source: https://onionservices.torproject.org/dev/certificates

Installs Easy-RSA and initializes a Public Key Infrastructure (PKI) for creating a custom Certificate Authority. Configuration variables for certificate requests are also set.

```bash
sudo apt update
sudo apt install -y easy-rsa
EASY_RSA="$HOME/code/easy-rsa"
mkdir -p $EASY_RSA
ln -s /usr/share/easy-rsa/* $EASY_RSA
chmod 700 $EASY_RSA
cd $EASY_RSA
./easyrsa init-pki
cat <<EOF >> pki/vars
set_var EASYRSA_REQ_COUNTRY    "US"
set_var EASYRSA_REQ_PROVINCE   "NewYork"
set_var EASYRSA_REQ_CITY       "New York City"
set_var EASYRSA_REQ_ORG        "Custom CA"
set_var EASYRSA_REQ_EMAIL      "admin@example.com"
set_var EASYRSA_REQ_OU         "Custom CA"
set_var EASYRSA_REQ_CN         "Custom CA"
set_var EASYRSA_ALGO           "ec"
set_var EASYRSA_DIGEST         "sha384"
set_var EASYRSA_CURVE          "secp384r1"
set_var EASYRSA_CERT_EXPIRE    "365"
EOF
./easyrsa build-ca nopass

```

--------------------------------

### choose(count=10, shuffle=True)

Source: https://onionservices.torproject.org/apps/base/onionbalance/api

Retrieves a specified number of introduction points from the available IP set. If more IPs are available than requested, it selects them to maximize distribution across backend instances. Optionally shuffles the returned list.

```APIDOC
## choose(count=10, shuffle=True)

### Description
Retrieve N introduction points from the set of IPs. Where more than `count` IPs are available, introduction points are selected to try and achieve the greatest distribution of introduction points across all of the available backend instances. Optionally shuffles the results.

### Method
This is a method call within a Python class, not an HTTP endpoint.

### Parameters
- **count** (int) - Optional - The number of introduction points to retrieve. Defaults to 10.
- **shuffle** (bool) - Optional - Whether to shuffle the returned list of introduction points. Defaults to True.

### Return Value
A list of IntroductionPoints.
```

--------------------------------

### Onionmine Vanity Address Generation Output

Source: https://onionservices.torproject.org/apps/base/onionmine/tutorial

Example output from the 'onionmine generate test' command, showing the process of configuring the pool, starting the mining process (mkp224o), and the final vanity address found.

```text
config: ensuring that /app/onionmine/pools/test/filters.lst exists...
generate: configuring pool test...
mine: starting mkp224o...
set workdir: /app/onionmine/pools/test/candidates/
sorting filters... done.
filters:
        test
in total, 1 filter
using 4 threads
testhowen7nxdusqncsns2yi3fjrjwqs4vkw7mobre4ageejenodread.onion
>calc/sec:960197.913134, succ/sec:9.975460, rest/sec:49.877302, elapsed:0.100246sec
waiting for threads to finish... done.
Current selected candidate for the test pool:

    testhowen7nxdusqncsns2yi3fjrjwqs4vkw7mobre4ageejenodread.onion

generate: keys for "test" saved at /app/onionmine/pools/test/candidates/testhowen7nxdusqncsns2yi3fjrjwqs4vkw7mobre4ageejenodread.onion

```

--------------------------------

### Get Master Key Path

Source: https://onionservices.torproject.org/apps/base/onionbalance/api

Determines the path to the master service private key. It can be provided via command-line arguments, user input during interactive setup, or left empty to indicate key generation.

```python
    def get_master_key_path(self, i):
        # Load master key if specified
        master_key_path = None
        helper = " (i.e. path to 'hs_ed25519_secret_key')"
        if self.interactive:
            # Read key path from user
            master_key_path = input("Service #%d: Enter path to master service private key%s "
                                    "(Leave empty to generate a key): " % 
                                    (i, helper))
        master_key_path = self.args.key or master_key_path

        # If a key path was specified make sure it exists
        if master_key_path:
            if not os.path.isfile(master_key_path):
                logger.error("The specified master service private key '%s' "
                             "could not be found. Please confirm the path and "
                             "file permissions are correct.", master_key_path)
                sys.exit(1)

        return master_key_path
```

--------------------------------

### Perform Wholesale Onionspray Update

Source: https://onionservices.torproject.org/apps/web/onionspray/guides/balance/softmaps

Safely updates the entire Onionspray setup by deploying a new balancer instance and new workers. This involves stopping the old balancer, starting the new one, and verifying its status before decommissioning the old instance.

```bash
onionspray ob-stop # this only affects Brenda, stops her pushing new descriptors

```

```bash
onionspray ob-start -a

```

```bash
onionspray ob-maps -a
onionspray ob-status -a

```

```bash
onionspray shutdown # which will further stop Onionspray on all of Brenda's workers

```

--------------------------------

### Get All Introduction Points

Source: https://onionservices.torproject.org/apps/base/onionbalance/api

Retrieves all introduction points for all instances of the service, packaged in an IntroductionPointSetV3. It handles cases where an instance might be missing a descriptor or is offline.

```APIDOC
## `get_all_intros_for_publish()`

### Description
Returns an IntroductionPointSetV3 containing all introduction points from all instances of this service. This is useful for publishing service descriptors.

### Returns
- An `IntroductionPointSetV3` object containing all introduction points.
```

--------------------------------

### Onionbalance Configuration File Example

Source: https://onionservices.torproject.org/apps/base/onionbalance/man/onionbalance

A sample configuration file for Onionbalance, demonstrating how to define multiple Onion Services, their backend instances, and their private keys. This file is essential for setting up Onionbalance.

```yaml
# Onion Load Balancer Config File example
#
# Each Onion Service key line should be associated with a list of 0 or more
# instances which contain the onion address of the load balancing backend
# service.

services:
- instances: # web
  - address: wmilwokvqistssclrjdi5arzrctn6bznkwmosvfyobmyv2fc3idbpwyd.onion
    name: web1
  - address: fp32xzad7wlnpd4n7jltrb3w3xyj23ppgsnuzhhkzlhbt5337aw2joad.onion
    name: web2
  key: lsainlbvqg6obox2xkcmlv65rlctarxzuzod4juicfj6cstmoimkxyyd.key
- instances: # irc
  - address: drdoqmg4p43tbtoqxuxs2ax2vgfpetqtvgnpdugh5b2i7f7zxrzvy7id.key
    name: irc1
  - address: u6uoeftsysttxeheyxtgdxssnhutmoo2y2rw6igh5ez4hpxaz4dap7ad.onion
    name: irc2
  key: 6kjmifbfmd2232gpsu7am2psp2ydennc4zhq53zcwlirps5jmpnaikyd.key


```

--------------------------------

### Distributing Services Across Multiple Projects

Source: https://onionservices.torproject.org/apps/web/onionspray/guides/balance/hardmaps

This example shows how to use 'hardmap' to distribute Onion Services across three separate Onionspray projects (project1, project2, project3). This setup results in independent Tor and NGINX instances for each project, enhancing load balancing.

```bash
user@onionspray:/home/user/onionspray$ grep hardmap *.conf
project1.conf:hardmap obep6i4wljp2atxkbjkeq7ycvhqa7eabs4rbocfut54wxer44bkfhqyd example.org
project1.conf:hardmap 3g4ul3iy55bkbjlesn26nj2oocsgot2mp63cintnyk4jshbhqtpofpid example.net
project1.conf:hardmap vnbuts3d3vfjjrgknxkma2wuyifwgs27qfkasm2h45zap7msamxwload somedomain.org
project2.conf:hardmap 3ln46qs2g7wzv75kjjc3r4ia5jv2mrojjdgby2vcdtsr3cswhg3l7xqd someotherdomain.com
project2.conf:hardmap 66yaevkgze2sxcetn45ynkp76rpgsuqg22hw2bj33qpc5plklmay2cyd anothersite.org
project2.conf:hardmap odxuyg67aqpedgjt5qxexnuixve3ule7o45yjubdbd3onqvlmzwzikad etcetctc.org
project3.conf:hardmap gwi5cpyyci4xlvgczchcyq353hukjdsgvthtaebqyqlmftds7ioprwyd thelistgoeson.org
project3.conf:hardmap 7zsdpgioajonm556fqgjts6huqcr3dc7ofvigl7sofzggnp6jq5ie5yd andonaonaon.org
project3.conf:hardmap zppyz4ta6en6x5z25zy5fztvuds4khrwcuvdveumhikzhbzpwsm3u7ad andsoandso.org
```

--------------------------------

### Softmap Configuration Example

Source: https://onionservices.torproject.org/apps/web/onionspray/guides/balance/topologies

Configure a softmap to use Onionbalance for load balancing. This maps 'example.org' and its subdomains to the specified Onion Service address, managed by Onionbalance.

```bash
softmap exampd5xof3blvnynaqvmusnq3wx6c7mstcl6aph3yiw4fnt5yzqj3ad.onion example.org

```

--------------------------------

### Install Onionspray

Source: https://onionservices.torproject.org/apps/web/onionspray/migrating

Installs Onionspray using git clone and a build script for Debian Trixie. Ensure git is installed first.

```bash
sudo apt update
sudo apt install -y git
git clone --recursive https://gitlab.torproject.org/tpo/onion-services/onionspray.git
cd onionspray
./opt/build-debian-trixie.sh
```

--------------------------------

### Hardmap Configuration Example

Source: https://onionservices.torproject.org/apps/web/onionspray/guides/balance/topologies

Configure a hardmap to map Onion Services to domain names. This maps 'example.org' and its subdomains to the specified Onion Service address.

```bash
hardmap exampd5xof3blvnynaqvmusnq3wx6c7mstcl6aph3yiw4fnt5yzqj3ad.onion example.org

```

--------------------------------

### Install Onionprobe using pipx

Source: https://onionservices.torproject.org/apps/web/onionprobe/installation

Installs Onionprobe using pipx, the recommended method for installing Python packages globally without virtual environments.

```bash
pipx install onionprobe
```

--------------------------------

### Install Onionprobe on Debian

Source: https://onionservices.torproject.org/apps/web/onionprobe/installation

Installs Onionprobe using the apt package manager on Debian-based systems. This command also installs the Tor daemon and other necessary dependencies.

```bash
sudo apt install onionprobe
```

--------------------------------

### Serve Public Build Artifacts

Source: https://onionservices.torproject.org/apps/web/onion-launchpad/build

Starts a basic HTTP server to inspect build artifacts in the `public/` folder. This is useful after building with GitLab Runner.

```bash
scripts/server-public

```

--------------------------------

### Start Onionbalance Management Server

Source: https://onionservices.torproject.org/apps/base/onionbalance/man/onionbalance

Use this command to start the Onionbalance management server with a specified configuration file. Ensure backend onion services are running before execution.

```bash
$ onionbalance -c config.yaml

```

--------------------------------

### Start Onionspray

Source: https://onionservices.torproject.org/apps/web/onionspray/migrating

Starts the Onionspray service with all services enabled.

```bash
./onionspray bounce -a
```

--------------------------------

### Get Introduction Points for Publishing

Source: https://onionservices.torproject.org/apps/base/onionbalance/api

Retrieves introduction points for publishing from a V3 onion service descriptor. Raises InstanceHasNoDescriptor if no descriptor is available or InstanceIsOffline if the descriptor is outdated.

```python
def get_intros_for_publish(self):
    """
    Get a list of stem.descriptor.IntroductionPointV3 objects for this descriptor

    Raise :InstanceHasNoDescriptor: if there is no descriptor for this instance
    Raise :InstanceIsOffline: if the instance is offline.
    """
    if not self.descriptor:
        raise InstanceHasNoDescriptor

    if self.descriptor.is_old():
        raise InstanceIsOffline

    return self.descriptor.get_intro_points()

```

--------------------------------

### Onionbalance Configuration File Example

Source: https://onionservices.torproject.org/apps/base/onionbalance/man/onionbalance-config

An example of a configuration file format for Onionbalance. This file defines services, their instances, and associated private keys.

```yaml
# Onion Load Balancer Config File example
#
# Each Onion Service key line should be associated with a list of 0 or more
# instances which contain the onion address of the load balancing backend
# service.

services:
- instances: # web
  - address: wmilwokvqistssclrjdi5arzrctn6bznkwmosvfyobmyv2fc3idbpwyd.onion
    name: web1
  - address: fp32xzad7wlnpd4n7jltrb3w3xyj23ppgsnuzhhkzlhbt5337aw2joad.onion
    name: web2
  key: lsainlbvqg6obox2xkcmlv65rlctarxzuzod4juicfj6cstmoimkxyyd.key
- instances: # irc
  - address: drdoqmg4p43tbtoqxuxs2ax2vgfpetqtvgnpdugh5b2i7f7zxrzvy7id.key
    name: irc1
  - address: u6uoeftsysttxeheyxtgdxssnhutmoo2y2rw6igh5ez4hpxaz4dap7ad.onion
    name: irc2
  key: 6kjmifbfmd2232gpsu7am2psp2ydennc4zhq53zcwlirps5jmpnaikyd.key

```

--------------------------------

### Import Onionprobe as Installed Package

Source: https://onionservices.torproject.org/apps/web/onionprobe/api

Import the `run_from_cmdline` function when Onionprobe is installed as a package.

```python
from onionprobe.app import run_from_cmdline

if __name__ == "__main__":
    run_from_cmdline()
```
Tokens:
Raw