logos-storage/logos-storage-DAppNodePackage
1
0
Fork 0
mirror of https://github.com/logos-storage/logos-storage-DAppNodePackage.git synced 2026-01-02 05:13:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

initial commit

Browse Source
This commit is contained in:
Slava 2025-02-13 14:42:22 +02:00
commit 71d795bf0a
No known key found for this signature in database
GPG Key ID: 351E7AA9BD0DFEB8
20 changed files with 1147 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.gitignore vendored Normal file
View File

@ -0,0 +1,4 @@
# DAppNodeSDK release directories
build_*
releases.json
docker-compose-tmp.yml

199
LICENSE-APACHE-2.0 Normal file
View File

@ -0,0 +1,199 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

19
LICENSE-MIT Normal file
View File

@ -0,0 +1,19 @@
MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

51
README.md Normal file
View File

@ -0,0 +1,51 @@
# Codex Dappnode package
<p align="center" width="100%">
<img src="avatar-codex.png" alt="Codex Dappnode package" />
</p>
## Description
[Codex](https://codex.storage) is a durable, decentralised storage protocol designed to safeguard the world's most valuable information.
Repository contains code to build Dappnode packages for Codex
- `Codex`
- `Codex local Geth`
We should select `Codex` package in case we would like to run Codex and use a Public RPC endpoint.
If we would like to run in a full P2P manner, `Codex local Geth` package contains additionally local Geth node and Codex will use it instead of the Public RPC endpoint.
## Installation
> [!NOTE]
> This code is in a **preview mode** and can be installed only from local builds. Please check [Development](docs/README.md#development) documentation for more details.
```shell
# Clone
git clone https://github.com/codex-storage/DAppNodePackage-codex
# Directory
cd DAppNodePackage-codex
# Build all packages ~ 10 minutes
npx @dappnode/dappnodesdk build --all-variants --provider=http://172.33.0.6:5001
```
## Todo
1. Automate package publishing using [GitHub Actions](https://docs.dappnode.io/docs/dev/github-actions).
2. Add metrics support based on the [DAppNodePackage-DMS](https://github.com/dappnode/DAppNodePackage-DMS).
## Known issues
1. Dappnode [Setup Wizard](https://docs.dappnode.io/docs/dev/references/setup-wizard) and UI does not permit to update port mapping port for container. And in that case we are using a default value, which is set to `8090` and appropriate Codex variable `CODEX_DISC_PORT=8090` - these values are **hardcoded** in the [docker-compose.yml](docker-compose.yml).
This also is a Codex limitation, because for DHT peers connection, we are using `src-ip:src-port` information and this can't be changed now. So, listener port must be equal with the forwarded one.
A single way to bypass that is to update, after installation, `CODEX_DISC_PORT` variable to the new value and add a new port forwarding in the the package Network settings.
2. Dappnode [Setup Wizard](https://docs.dappnode.io/docs/dev/references/setup-wizard) is not supported for [Multi-Config Package](https://docs.dappnode.io/docs/dev/package-development/multi-configuration), so our main *setup-wizard.yml* does not contain any settings for Geth configuration and we are using all hardcoded values.

BIN
avatar-codex.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 11 KiB

3
codex-app/Dockerfile Normal file
View File

@ -0,0 +1,3 @@
ARG UPSTREAM_VERSION_CODEX_APP
FROM codexstorage/codex-marketplace-ui:${UPSTREAM_VERSION_CODEX_APP}

5
codex-node/Dockerfile Normal file
View File

@ -0,0 +1,5 @@
ARG UPSTREAM_VERSION_CODEX_NODE
FROM codexstorage/nim-codex:${UPSTREAM_VERSION_CODEX_NODE}
COPY --chmod=0755 docker-entrypoint.sh /

152
codex-node/docker-entrypoint.sh Normal file
View File

@ -0,0 +1,152 @@
#!/bin/bash
# Environment variables from files
# If set to file path, read the file and export the variables
# If set to directory path, read all files in the directory and export the variables
if [[ -n "${ENV_PATH}" ]]; then
set -a
[[ -f "${ENV_PATH}" ]] && source "${ENV_PATH}" || for f in "${ENV_PATH}"/*; do source "$f"; done
set +a
fi
# Parameters
if [[ -z "${CODEX_NAT}" ]]; then
if [[ "${NAT_IP_AUTO}" == "true" && -z "${NAT_PUBLIC_IP_AUTO}" ]]; then
export CODEX_NAT=$(hostname --ip-address)
echo "Private: CODEX_NAT=${CODEX_NAT}"
elif [[ -n "${NAT_PUBLIC_IP_AUTO}" ]]; then
# Run for 60 seconds if fail
WAIT=120
SECONDS=0
SLEEP=5
while (( SECONDS < WAIT )); do
export CODEX_NAT=$(curl -s -f -m 5 "${NAT_PUBLIC_IP_AUTO}")
# Check if exit code is 0 and returned value is not empty
if [[ $? -eq 0 && -n "${CODEX_NAT}" ]]; then
echo "Public: CODEX_NAT=${CODEX_NAT}"
break
else
# Sleep and check again
echo "Can't get Public IP - Retry in $SLEEP seconds / $((WAIT - SECONDS))"
sleep $SLEEP
fi
done
fi
fi
# Stop Codex run if can't get NAT IP when requested
if [[ "${NAT_IP_AUTO}" == "true" && -z "${CODEX_NAT}" ]]; then
echo "Can't get Private IP - Stop Codex run"
exit 1
elif [[ -n "${NAT_PUBLIC_IP_AUTO}" && -z "${CODEX_NAT}" ]]; then
echo "Can't get Public IP in $WAIT seconds - Stop Codex run"
exit 1
fi
# If marketplace is enabled from the testing environment,
# The file has to be written before Codex starts.
for key in PRIV_KEY ETH_PRIVATE_KEY; do
keyfile="private.key"
if [[ -n "${!key}" ]]; then
[[ "${key}" == "PRIV_KEY" ]] && echo "PRIV_KEY variable is deprecated and will be removed in the next releases, please use ETH_PRIVATE_KEY instead!"
echo "${!key}" > "${keyfile}"
chmod 600 "${keyfile}"
export CODEX_ETH_PRIVATE_KEY="${keyfile}"
echo "Private key set"
fi
done
# Set arguments
if [[ "${MODE}" == "codex-node-with-marketplace" ]]; then
set -- "$@" persistence
[[ -z "${CODEX_MARKETPLACE_ADDRESS}" ]] && unset CODEX_MARKETPLACE_ADDRESS
elif [[ "${MODE}" == "codex-storage-node" ]]; then
set -- "$@" persistence prover
else
unset CODEX_ETH_PROVIDER
fi
# Set network parameters
if [[ "${NETWORK}" == "testnet" ]]; then
bootstrap_nodes=(
--bootstrap-node=spr:CiUIAhIhAiJvIcA_ZwPZ9ugVKDbmqwhJZaig5zKyLiuaicRcCGqLEgIDARo8CicAJQgCEiECIm8hwD9nA9n26BUoNuarCEllqKDnMrIuK5qJxFwIaosQ3d6esAYaCwoJBJ_f8zKRAnU6KkYwRAIgM0MvWNJL296kJ9gWvfatfmVvT-A7O2s8Mxp8l9c8EW0CIC-h-H-jBVSgFjg3Eny2u33qF7BDnWFzo7fGfZ7_qc9P
--bootstrap-node=spr:CiUIAhIhAyUvcPkKoGE7-gh84RmKIPHJPdsX5Ugm_IHVJgF-Mmu_EgIDARo8CicAJQgCEiEDJS9w-QqgYTv6CHzhGYog8ck92xflSCb8gdUmAX4ya78QoemesAYaCwoJBES39Q2RAnVOKkYwRAIgLi3rouyaZFS_Uilx8k99ySdQCP1tsmLR21tDb9p8LcgCIG30o5YnEooQ1n6tgm9fCT7s53k6XlxyeSkD_uIO9mb3
--bootstrap-node=spr:CiUIAhIhA6_j28xa--PvvOUxH10wKEm9feXEKJIK3Z9JQ5xXgSD9EgIDARo8CicAJQgCEiEDr-PbzFr74--85TEfXTAoSb195cQokgrdn0lDnFeBIP0QzOGesAYaCwoJBK6Kf1-RAnVEKkcwRQIhAPUH5nQrqG4OW86JQWphdSdnPA98ErQ0hL9OZH9a4e5kAiBBZmUl9KnhSOiDgU3_hvjXrXZXoMxhGuZ92_rk30sNDA
--bootstrap-node=spr:CiUIAhIhA7E4DEMer8nUOIUSaNPA4z6x0n9Xaknd28Cfw9S2-cCeEgIDARo8CicAJQgCEiEDsTgMQx6vydQ4hRJo08DjPrHSf1dqSd3bwJ_D1Lb5wJ4Qt_CesAYaCwoJBEDhWZORAnVYKkYwRAIgFNzhnftocLlVHJl1onuhbSUM7MysXPV6dawHAA0DZNsCIDRVu9gnPTH5UkcRXLtt7MLHCo4-DL-RCMyTcMxYBXL0
--bootstrap-node=spr:CiUIAhIhAzZn3JmJab46BNjadVnLNQKbhnN3eYxwqpteKYY32SbOEgIDARo8CicAJQgCEiEDNmfcmYlpvjoE2Np1Wcs1ApuGc3d5jHCqm14phjfZJs4QrvWesAYaCwoJBKpA-TaRAnViKkcwRQIhANuMmZDD2c25xzTbKSirEpkZYoxbq-FU_lpI0K0e4mIVAiBfQX4yR47h1LCnHznXgDs6xx5DLO5q3lUcicqUeaqGeg
--bootstrap-node=spr:CiUIAhIhAgybmRwboqDdUJjeZrzh43sn5mp8jt6ENIb08tLn4x01EgIDARo8CicAJQgCEiECDJuZHBuioN1QmN5mvOHjeyfmanyO3oQ0hvTy0ufjHTUQh4ifsAYaCwoJBI_0zSiRAnVsKkcwRQIhAJCb_z0E3RsnQrEePdJzMSQrmn_ooHv6mbw1DOh5IbVNAiBbBJrWR8eBV6ftzMd6ofa5khNA2h88OBhMqHCIzSjCeA
--bootstrap-node=spr:CiUIAhIhAntGLadpfuBCD9XXfiN_43-V3L5VWgFCXxg4a8uhDdnYEgIDARo8CicAJQgCEiECe0Ytp2l-4EIP1dd-I3_jf5XcvlVaAUJfGDhry6EN2dgQsIufsAYaCwoJBNEmoCiRAnV2KkYwRAIgXO3bzd5VF8jLZG8r7dcLJ_FnQBYp1BcxrOvovEa40acCIDhQ14eJRoPwJ6GKgqOkXdaFAsoszl-HIRzYcXKeb7D9
)
fi
# Update arguments
set -- "$@" ${bootstrap_nodes[@]} ${EXTRA_OPTS}
# Check if the endpoint is synced
if [[ -n "${CODEX_ETH_PROVIDER}" ]]; then
echo "Marketplace is enabled - Check if the endpoint is synced"
timeout=3
interval=5
endpoint="${CODEX_ETH_PROVIDER}"
while true; do
block=$(curl -m $timeout -X POST \
-s "${CODEX_ETH_PROVIDER}" \
-H 'Content-Type: application/json' \
-d '{"jsonrpc":"2.0","method":"eth_getBlockByNumber","params":["latest",false],"id":0}' | jq -r '.result.number')
block=$(("${block}"))
sync=$(curl -m $timeout -X POST \
-s "${CODEX_ETH_PROVIDER}" \
-H 'Content-Type: application/json' \
-w %{time_total} \
-d '{"jsonrpc":"2.0","method":"eth_syncing","params":[],"id":1}')
sync=$(echo $sync | tr '\n' ' ')
if [[ $sync == *false* ]]; then
echo "$(date) - Endpoint ${endpoint} is Synced, go to run - block $block - $sync"
break
else
echo "$(date) - Endpoint ${endpoint} is Not synced, waiting - block $block - $sync"
fi
sleep $interval
done
else
echo "Marketplace is disabled - Skip endpoint sync check"
fi
# Circuit downloader
# cirdl [circuitPath] [rpcEndpoint] [marketplaceAddress]
if [[ "$@" == *"prover"* ]]; then
echo "Prover is enabled - Run Circuit downloader"
# Set variables required by cirdl from command line arguments when passed
for arg in data-dir circuit-dir eth-provider marketplace-address; do
arg_value=$(grep -o "${arg}=[^ ,]\+" <<< $@ | awk -F '=' '{print $2}')
if [[ -n "${arg_value}" ]]; then
var_name=$(tr '[:lower:]' '[:upper:]' <<< "CODEX_${arg//-/_}")
export "${var_name}"="${arg_value}"
fi
done
# Set circuit dir from CODEX_CIRCUIT_DIR variables if set
if [[ -z "${CODEX_CIRCUIT_DIR}" ]]; then
export CODEX_CIRCUIT_DIR="${CODEX_DATA_DIR}/circuits"
fi
# Download circuit
mkdir -p "${CODEX_CIRCUIT_DIR}"
chmod 700 "${CODEX_CIRCUIT_DIR}"
download="cirdl ${CODEX_CIRCUIT_DIR} ${CODEX_ETH_PROVIDER} ${CODEX_MARKETPLACE_ADDRESS}"
echo "${download}"
eval "${download}"
[[ $? -ne 0 ]] && { echo "Failed to download circuit files"; exit 1; }
fi
# Show
echo "Codex parameters:"
vars=$(env | grep CODEX_)
echo -e "${vars//CODEX_/ - CODEX_}"
echo -e " $@"
# Run
echo "Run Codex node..."
exec "$@"

34
dappnode_package.json Normal file
View File

@ -0,0 +1,34 @@
{
"upstream": [
{
"repo": "codex-storage/nim-codex",
"version": "0.1.9",
"arg": "UPSTREAM_VERSION_CODEX_NODE"
},
{
"repo": "codexstorage/codex-marketplace-ui",
"version": "0.0.13",
"arg": "UPSTREAM_VERSION_CODEX_APP"
},
{
"repo": "ethereum/client-go",
"version": "v1.13.15",
"arg": "UPSTREAM_VERSION_GETH"
}
],
"shortDescription": "Codex Storage - Decentralized Durability Engine",
"description": "Codex is a durable, decentralised storage protocol designed to safeguard the world's most valuable information. Join the testnet to help secure a resilient digital future.",
"type": "service",
"mainService": "codex-app",
"architectures": ["linux/amd64", "linux/arm64"],
"author": "Codex DevOps",
"categories": ["Storage"],
"repository": {
"type": "git",
"url": "https://github.com/codex-storage/DAppNodePackage-codex.git"
},
"bugs": {
"url": "https://github.com/codex-storage/nim-codex/issues"
},
"license": "Apache-2.0, MIT"
}

59
docker-compose.yml Normal file
View File

@ -0,0 +1,59 @@
version: "3.8"
services:
codex-node:
build:
context: ./codex-node
dockerfile: Dockerfile
args:
UPSTREAM_VERSION_CODEX_NODE: 0.1.9
image: codex-node.public.dappnode.eth:0.1.0
restart: unless-stopped
environment:
MODE: codex-node-with-marketplace
NETWORK: testnet
IP_MODE: auto
EXTRA_OPTS: ""
CODEX_DATA_DIR: /data
CODEX_NAT: ""
# CODEX_METRICS: "false"
# CODEX_METRICS_ADDRESS: 0.0.0.0
# CODEX_METRICS_PORT: 8008
CODEX_API_BINDADDR: 0.0.0.0
CODEX_API_PORT: 8080
CODEX_LISTEN_ADDRS: /ip4/0.0.0.0/tcp/8070
CODEX_DISC_PORT: 8090
CODEX_LOG_LEVEL: info
CODEX_STORAGE_QUOTA: 8gb
CODEX_BLOCK_TTL: 24h
CODEX_API_CORS_ORIGIN: "*"
CODEX_MARKETPLACE_ADDRESS: ""
CODEX_ETH_PROVIDER: https://rpc.testnet.codex.storage
ETH_PRIVATE_KEY: ""
NAT_PUBLIC_IP_AUTO: https://ip.codex.storage
ports:
- 8070:8070/tcp # P2P transport
- 8090:8090/udp # P2P discovery
volumes:
- codex-node-data:/data
logging:
driver: json-file
options:
max-size: 100m
max-file: 5
codex-app:
build:
context: ./codex-app
dockerfile: Dockerfile
args:
UPSTREAM_VERSION_CODEX_APP: 0.0.13
image: codex-app.public.dappnode.eth:0.1.0
restart: unless-stopped
logging:
driver: json-file
options:
max-size: 100m
max-file: 5
volumes:
codex-node-data: {}

210
docs/README.md Normal file
View File

@ -0,0 +1,210 @@
# Dappnode package development
1. [Description](#description)
2. [Server](#server)
3. [Install](#install)
4. [Connect](#connect)
5. [Considerations](#considerations)
6. [Development](#development)
7. [Publish](#publish)
8. [Limitations](#limitations)
9. [Known issues](#known-issues)
## Description
Dappnode packages supports two types of [configuration](https://docs.dappnode.io/docs/dev/package-development/overview)
- [Single Configuration](https://docs.dappnode.io/docs/dev/package-development/single-configuration) - Used to generate a single package, tailored for a specific configuration.
- [Multi-Configuration](https://docs.dappnode.io/docs/dev/package-development/multi-configuration) - Used to generate multiple packages with varying configurations, such as different networks or client setups.
Provided guide is focused on Multi-Configuration variant because it provides more flexibility.
The easiest way to develop the package is to use a VM and in that guide we will use Hetzner Cloud.
- [Docs](https://docs.dappnode.io)
- [Package Development](https://docs.dappnode.io/docs/dev/package-development/overview)
## Server
1. Run an Ubuntu VM on Hetzner - `8vCPU/16GB RAM` (`cx42/cpx41`)
2. Create firewall rules based on the [Cloud Providers / AWS](https://docs.dappnode.io/docs/user/dappnode-cloud/providers/aws/set-up-instance/) guide
| Protocol | Port | Service | Source | Comment |
| -------- | ------------ | ------------- | ----------- | ------------------------------------ |
| `TCP` | `22` | `SSH` | `0.0.0.0/0` | |
| `TCP` | `80` | `HTTP` | `0.0.0.0/0` | Required for services exposing only? |
| `TCP` | `443` | `HTTP` | `0.0.0.0/0` | Required for services exposing only? |
| `UDP` | `51820` | `Wireguard` | `0.0.0.0/0` | |
| `TCP` | `1024-65535` | `General TCP` | `0.0.0.0/0` | |
| `UDP` | `1024-65535` | `General UDP` | `0.0.0.0/0` | |
## Install
1. We can install Dappnode on Ubuntu VM using [Script installation](https://docs.dappnode.io/docs/user/install/script/)
```shell
# Prerequisites
sudo wget -O - https://prerequisites.dappnode.io | sudo bash
# Dappnode
sudo wget -O - https://installer.dappnode.io | sudo bash
# Restart
sudo reboot
```
## Connect
> [!NOTE]
> Please wait for 1-3 minutes after node was started.
1. Check Dappnode status
```shell
dappnode_status
```
2. Run Dappnode if not started
```shell
dappnode_start
```
3. Get wireguard credentials and connect to the Dappnode instance - [WireGuard Access to Dappnode](https://docs.dappnode.io/docs/user/access-your-dappnode/vpn/wireguard/)
```shell
dappnode_wireguard
```
4. Open http://my.dappnode in the browser.
## Considerations
1. Users might run a lot of different packages, which can use some standard ports like `30303`, this is why we used different default ports
```shell
30303 --> 40303
```
Just add 10000 to every port.
## Development
1. Clone GitHub repository on local machine
```shell
git clone https://github.com/codex-storage/DAppNodePackage-codex
# For new package run 'init'
# npx @dappnode/dappnodesdk init --use-variants --dir DAppNodePackage-codex
```
Add you changes to the code.
2. Copy package files to Dappnode server
```shell
local_dir="DAppNodePackage-codex"
remote_dir="/opt/DAppNodePackage-codex"
host="root@<server-ip>"
rsync -avze ssh --rsync-path='sudo rsync --mkpath' "${local_dir}/" "${host}:${remote_dir}/" --delete
```
3. Install [Node.js](Node.js) on Dappnode server using [nvm](https://github.com/nvm-sh/nvm)
```shell
# nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash
# Load
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm
# Node 20
nvm install 20
# Check
node --version
# v20.18.2
```
4. Install [DAppNodeSDK](https://github.com/dappnode/DAppNodeSDK) on remote Dappnode
```shell
# Install
npx -y @dappnode/dappnodesdk
# Help
npx @dappnode/dappnodesdk --help
```
5. Get Dappnode IPFS IP: `Packages` --> `System packages` --> `Ipfs` --> `Network` --> `Container IP`
6. Build the package
```shell
# Code directory - multi-arch builds failed with --dir argument
cd /opt/DAppNodePackage-codex
# Use Ipfs node IP
npx @dappnode/dappnodesdk build --all-variants --provider=http://172.33.0.2:5001
```
```
Dappnode Package (codex.public.dappnode.eth) built and uploaded
DNP name : codex.public.dappnode.eth
Release hash : /ipfs/QmR7HVCpyWyDLGswF5Z1FXebrr3XjbWZeYQV2bhq5e4v1Q
http://my.dappnode/installer/public/%2Fipfs%2FQmR7HVCpyWyDLGswF5Z1FXebrr3XjbWZeYQV2bhq5e4v1Q
```
7. Install the package via DAppStore and using IPFS CID from previous step and check `Bypass only signed safe restriction`
## Publish
- [Package Publishing](https://docs.dappnode.io/docs/dev/package-publishing/publish-packages-clients)
## Limitations
1. Dappnode packages are built on top of the [Docker Compose](https://docs.docker.com/compose/) which has limited configuration flexibility and DAppNodeSDK does not provide any workarounds.
2. Docker Compose base imply the following limitations
- Variables
- If we need to pass an optional environment variable, it needs to be defined in Compose file with some default value and it anyway will be passed to the container
- If that optional variable can't accept a blank value, we should undefine it conditionally in the Docker entrypoint
- Ports
- If we need to define an optional port forwarding, it needs to be defined in Compose file with some default values and it anyway will be active and take the port on the node
- There is no way to configure "really optional" port forwarding
- A workaround would be use a separate package variant, but it is to big overhead
3. We can't have a relation between variable and port forwarding, to setup same value using a single field. User have to fill separately two fields with the same value.
4. Multi-Configuration package does not provide a real flexibility, it just generate multiple separate packages and it doesn't work like a single package with multiple options during the installation.
5. [Using profiles with Compose](https://docs.docker.com/compose/how-tos/profiles/) is not supported.
6. There is no way to setup a custom service name during package installation and it is predefined in the main `dappnode_package.json`
- We can set an alias like `codex.public.dappnode --> codex-app.codex.public.dappnode`
- That can be done for a single service in the package
7. Is there a way to adjust container port for [Published ports](https://docs.docker.com/engine/network/#published-ports) or we can configure just host port?
8. File [`setup-wizard.yml`](<https://docs.dappnode.io/docs/dev/references/setup-wizard>) is not supported in [Multi-Config Package Development](<https://docs.dappnode.io/docs/dev/package-development/multi-configuration>) which is very confusing. And same issue is with the `getting-started.md`.
9. There is no way to setup custom service names for multiple services and they all namespaced under the `package name`
```shell
# Public packages
geth.codex.public.dappnode
codex-app.codex.public.dappnode
codex-node.codex.public.dappnode
```
1. When we have Multi-Configuration package, we should define different package name for each variant, which imply different namespaces for services names and that looks not so nice, for example
```shell
# Package codex
codex.public.dappnode --> codex-app.codex.public.dappnode
codex-app.codex.public.dappnode
codex-node.codex.public.dappnode
# Package codex-local-geth
codex-local-geth.public.dappnode --> codex-app.codex-local-geth.public.dappnode
codex-app.codex-local-geth.public.dappnode
codex-node.codex-local-geth.public.dappnode
geth.codex-local-geth.public.dappnode
```
If we would like to have separate packages, which would permit to use same handy URL like `codex.public.dappnode` for main service, and other services under that namespace, it would be required to have separate repositories(package folders) with the same package name. It can be a cosmetic point, but it highlights a limitation we have.
## Known issues
1. Latest [Node.js LTS release 22](https://nodejs.org/en/about/previous-releases), is not supported and we should use version 20.
2. During local package build it is uploaded to the local IPFS node, but in the Dappnode UI package avatar is loaded from the https://gateway.ipfs.dappnode.io, so most probably it will not be shown and it is not so clear what is the issue. Maybe something is wrong with avatar or something else? We can use default avatar, which is known by Dappnode IPFS gateway.
3. File `getting-started.md` is not specified in the official documentation, but it exists and is very usefully.
4. Dappnodesdk does not support `compose.yaml` file, [which is default and preferred](https://docs.docker.com/compose/intro/compose-application-model/).
5. Often time it can be more effective to [explorer existing packages](https://github.com/dappnode?q=DAppNodePackage&type=all&language=&sort=) configuration, than to use a documentation.
6. During the package build, Docker warn that ["the attribute `version` is obsolete"](https://docs.docker.com/reference/compose-file/version-and-name/#version-top-level-element-obsolete), but dappnodesdk will fail if we remove it - that is very confusing.

17
geth/Dockerfile Normal file
View File

@ -0,0 +1,17 @@
# Variables
ARG UPSTREAM_VERSION_GETH
ARG GENESIS_DIR=/
ARG GENESIS_PREFIX=genesis
# Create
FROM ethereum/client-go:${UPSTREAM_VERSION_GETH}
ARG GENESIS_DIR
ARG GENESIS_PREFIX
COPY --chmod=0755 ${GENESIS_PREFIX}-*.json ${GENESIS_DIR}
COPY --chmod=0755 docker-entrypoint.sh /docker-entrypoint.sh
ENV GENESIS_DIR=${GENESIS_DIR}
ENV GENESIS_PREFIX=${GENESIS_PREFIX}
ENTRYPOINT ["/docker-entrypoint.sh"]

26
geth/docker-entrypoint.sh Normal file
View File

@ -0,0 +1,26 @@
#!/bin/sh
# Network
if [ "${NETWORK}" = "testnet" ]; then
export GETH_BOOTNODES=enode://cff0c44c62ecd6e00d72131f336bb4e4968f2c1c1abeca7d4be2d35f818608b6d8688b6b65a18f1d57796eaca32fd9d08f15908a88afe18c1748997235ea6fe7@159.223.243.50:40010,enode://ea331eaa8c5150a45b793b3d7c17db138b09f7c9dd7d881a1e2e17a053e0d2600e0a8419899188a87e6b91928d14267949a7e6ec18bfe972f3a14c5c2fe9aecb@68.183.245.13:40030,enode://4a7303b8a72db91c7c80c8fb69df0ffb06370d7f5fe951bcdc19107a686ba61432dc5397d073571433e8fc1f8295127cabbcbfd9d8464b242b7ad0dcd35e67fc@174.138.127.95:40020,enode://36f25e91385206300d04b95a2f8df7d7a792db0a76bd68f897ec7749241b5fdb549a4eecfab4a03c36955d1242b0316b47548b87ad8291794ab6d3fecda3e85b@64.225.89.147:40040,enode://2e14e4a8092b67db76c90b0a02d97d88fc2bb9df0e85df1e0a96472cdfa06b83d970ea503a9bc569c4112c4c447dbd1e1f03cf68471668ba31920ac1d05f85e3@170.64.249.54:40050,enode://6eeb3b3af8bef5634b47b573a17477ea2c4129ab3964210afe3b93774ce57da832eb110f90fbfcfa5f7adf18e55faaf2393d2e94710882d09d0204a9d7bc6dd2@143.244.205.40:40060,enode://6ba0e8b5d968ca8eb2650dd984cdcf50acc01e4ea182350e990191aadd79897801b79455a1186060aa3818a6bc4496af07f0912f7af53995a5ddb1e53d6f31b5@209.38.160.40:40070
fi
# Show
echo "Geth parameters:"
vars=$(env | grep GETH_)
echo -e "${vars//GETH_/ - GETH_}"
echo -e " $@"
# Genesis
echo "Create Genesis block"
if [ -d "${GETH_DATADIR}/geth/chaindata" ]; then
echo "Genesis block was already created"
else
echo "Creating Genesis block"
echo "geth init --datadir ${GETH_DATADIR} ${GENESIS_DIR}${GENESIS_PREFIX}-${NETWORK}.json"
geth init --datadir "${GETH_DATADIR}" "${GENESIS_DIR}${GENESIS_PREFIX}-${NETWORK}.json"
fi
# Run
echo "Run Geth node..."
geth

34
geth/genesis-testnet.json Normal file
View File

@ -0,0 +1,34 @@
{
"config": {
"chainId": 789987,
"homesteadBlock": 0,
"eip150Block": 0,
"eip155Block": 0,
"eip158Block": 0,
"byzantiumBlock": 0,
"constantinopleBlock": 0,
"petersburgBlock": 0,
"istanbulBlock": 0,
"muirGlacierBlock": 0,
"berlinBlock": 0,
"londonBlock": 0,
"arrowGlacierBlock": 0,
"grayGlacierBlock": 0,
"clique": {
"period": 10,
"epoch": 30000
}
},
"difficulty": "1",
"gasLimit": "8000000",
"extradata": "0x00000000000000000000000000000000000000000000000000000000000000003a39904b71595608524274bfd8c20fcfd9e772360000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"alloc": {
"0x3a39904b71595608524274bfd8c20fcfd9e77236": { "balance": "100000000000000000000000000" },
"0x28840F2a7869E1dBe1Ef90Db08Bf50c74614c37e": { "balance": "100000000000000000000000000" },
"0x1fa74c3DD6050799BA74D4363D6036E22FAF05F6": { "balance": "100000000000000000000000000" },
"0x7f60982Ad4eF64FC42455Ba666fcFc8DBdDf2F1D": { "balance": "100000000000000000000000000" },
"0x7558f20595678c78961a61bE6F9BF3615C1b1C60": { "balance": "100000000000000000000000000" },
"0x4Fed456c1b4F1F4cA085c18475feE2E3cdE056f8": { "balance": "100000000000000000000000000" },
"0xa1671207A037a1133018eaaCb0DA51b2FE789d35": { "balance": "100000000000000000000000000" }
}
}

28
getting-started.md Normal file
View File

@ -0,0 +1,28 @@
## Welcome to your Codex Node
Thanks for being a part of the Codex decentralized storage network.
##### Codex package
* Codex App: [codex.public.dappnode](http://codex.public.dappnode)
* Codex Node API: `http://codex-node.codex.public.dappnode:8080`
----
##### Codex with local Geth package
After installation, please wait some time, until Geth will sync with the network. It might take up to 30 minutes.
During that time, Codex Node API is not available and you can't connect to it using Codex App.
* Codex App: [codex-local-geth.public.dappnode](http://codex-local-geth.public.dappnode)
* Codex Node API: `http://codex-node.codex-local-geth.public.dappnode:8080`
* Geth HTTP RPC: `http://geth.codex-local-geth.public.dappnode:8545`
----
#### Next steps
* Check the [documentation](https://docs.codex.storage)
* Want to stay up-date, or looking for further assistance? Try our [discord-server](https://discord.gg/codex-storage).
* Ready to explore Codex functionality? Please [Join Codex Testnet](https://docs.codex.storage/networks/testnet).

9
package_variants/codex-local-geth/dappnode_package.json Normal file
View File

@ -0,0 +1,9 @@
{
"name": "codex-local-geth.public.dappnode.eth",
"version": "0.1.0",
"links": {
"homepage": "https://codex.storage",
"ui": "http://codex-local-geth.public.dappnode",
"api": "http://codex-node.codex-local-geth.public.dappnode:8080/api/codex/v1"
}
}

48
package_variants/codex-local-geth/docker-compose.yml Normal file
View File

@ -0,0 +1,48 @@
version: "3.8"
services:
codex-node:
environment:
CODEX_ETH_PROVIDER: http://geth.codex-local-geth.public.dappnode:8545
depends_on:
- geth
geth:
build:
context: ./geth
dockerfile: Dockerfile
args:
UPSTREAM_VERSION_GETH: v1.13.15
image: geth.codex.public.dappnode.eth:0.1.0
restart: unless-stopped
environment:
NETWORK: testnet
GETH_DATADIR: /data
GETH_NETWORKID: 789987
GETH_SYNCMODE: snap
GETH_GCMODE: full
GETH_NAT: auto
GETH_PORT: 40303
GETH_DISCOVERY_PORT: 40303
GETH_VERBOSITY: 3
GETH_HTTP: true
GETH_HTTP_PORT: 8545
GETH_HTTP_ADDR: 0.0.0.0
GETH_HTTP_VHOSTS: "*"
GETH_HTTP_CORSDOMAIN: "*"
GETH_WS: true
GETH_WS_PORT: 8546
GETH_WS_ADDR: 0.0.0.0
GETH_WS_ORIGINS: "*"
ports:
- 40303:40303/tcp # Network
- 40303:40303/udp # P2P discovery
volumes:
- geth-data:/data
logging:
driver: json-file
options:
max-size: 100m
max-file: 5
volumes:
geth-data: {}

9
package_variants/codex/dappnode_package.json Normal file
View File

@ -0,0 +1,9 @@
{
"name": "codex.public.dappnode.eth",
"version": "0.1.0",
"links": {
"homepage": "https://codex.storage",
"ui": "http://codex.public.dappnode",
"api": "http://codex-node.codex.public.dappnode:8080/api/codex/v1"
}
}

1
package_variants/codex/docker-compose.yml Normal file
View File

@ -0,0 +1 @@
version: "3.8"

239
setup-wizard.yml Normal file
View File

@ -0,0 +1,239 @@
version: "2"
fields:
- id: MODE
target:
type: environment
name: MODE
service: codex-node
title: Codex mode
description: >-
- **`Codex node`** - useful for local testing/development and basic/files sharing.
- **`Codex node with marketplace support`** (`Recommended`) - you can share files and buy the storage, this is the main mode and should be used by the end users.
- **`Codex storage node`** - should be used by storage providers or if you would like to sell your local storage.
enum:
- codex-node
- codex-node-with-marketplace
- codex-storage-node
required: true
- id: NETWORK
target:
type: environment
name: NETWORK
service: [codex-node, geth]
title: Codex network
description: >-
- **`Testnet`** - Codex Testnet network. Please check the [docs](https://docs.codex.storage/networks/networks) for available networks.
enum:
- testnet
required: true
- id: ETH_PRIVATE_KEY
target:
type: environment
name: ETH_PRIVATE_KEY
service: codex-node
title: ETH_PRIVATE_KEY
description: >-
Ethereum private key which will be saved to a file and passed as a value for `CODEX_ETH_PRIVATE_KEY` variable.
secret: true
pattern: "^0x[a-fA-F0-9]{64}$"
patternErrorMessage: Must be a valid private key (0x1fd16a...)
required: true
if: { "MODE": { "enum": ["codex-node-with-marketplace", "codex-storage-node"] } }
- id: CODEX_ETH_PROVIDER
target:
type: environment
name: CODEX_ETH_PROVIDER
service: codex-node
title: CODEX_ETH_PROVIDER
description: >-
The URL of the JSON-RPC API of the Ethereum node - use [Public RPC endpoint](https://docs.codex.storage/networks/networks) or local Geth node RPC.
pattern: >-
^(http(s|)\:\/\/|)((([a-zA-Z0-9-_]{1,}\.){1,})([a-zA-Z]{1}[a-zA-Z0-9-]{1,}))(:[0-9]{1,}|)(\/[a-zA-Z0-9_~#?\+\&\.\/-=%-]{1,}|)$
patternErrorMessage: Must be a valid URL
required: true
if: { "MODE": { "enum": ["codex-node-with-marketplace", "codex-storage-node"] } }
# We can't make 'required' conditional and need to define save variable two times
- id: CODEX_MARKETPLACE_ADDRESS-node-with-marketplace-support
target:
type: environment
name: CODEX_MARKETPLACE_ADDRESS
service: codex-node
title: CODEX_MARKETPLACE_ADDRESS
description: >-
Address of deployed Marketplace contract.
We should set this variable **only if we would like to override auto-detected address**. Please check the address for the network you are using in the [docs](https://docs.codex.storage/networks/networks).
pattern: "^0x[a-fA-F0-9]{40}$"
patternErrorMessage: Must be a valid Ethereum address
required: false
if: { "MODE": { "enum": ["codex-node-with-marketplace"] } }
- id: CODEX_MARKETPLACE_ADDRESS-storage-node
target:
type: environment
name: CODEX_MARKETPLACE_ADDRESS
service: codex-node
title: CODEX_MARKETPLACE_ADDRESS
description: >-
Address of deployed Marketplace contract.
We should set this variable because we are running in **Codex `storage node`** mode. Please check the address for the network you are using in the [docs](https://docs.codex.storage/networks/networks).
pattern: "^0x[a-fA-F0-9]{40}$"
patternErrorMessage: Must be a valid Ethereum address
required: true
if: { "MODE": { "enum": ["codex-storage-node"] } }
- id: IP_MODE
target:
type: environment
name: IP_MODE
service: codex-node
title: IP detection mode
description: >-
Set your Public IP address manually or use autodetection.
enum:
- auto
- manual
required: true
- id: CODEX_NAT
target:
type: environment
name: CODEX_NAT
service: codex-node
title: CODEX_NAT
description: >-
Public IP address to announce behind a NAT.
pattern: "^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]?|0).){3}(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]?|0)$"
patternErrorMessage: Must be a valid IP address
required: true
if: { "IP_MODE": { "enum": ["manual"] } }
- id: NAT_PUBLIC_IP_AUTO
target:
type: environment
name: NAT_PUBLIC_IP_AUTO
service: codex-node
title: NAT_PUBLIC_IP_AUTO
description: >-
IP Lookup Service URL to be used to Public IP address autodetect, default = [`https://ip.codex.storage`](https://ip.codex.storage).
pattern: >-
^(http(s|)\:\/\/|)((([a-zA-Z0-9-_]{1,}\.){1,})([a-zA-Z]{1}[a-zA-Z0-9-]{1,}))(:[0-9]{1,}|)(\/[a-zA-Z0-9_~#?\+\&\.\/-=%-]{1,}|)$
patternErrorMessage: Must be a valid URL
required: true
if: { "IP_MODE": { "enum": ["auto"] } }
# - id: CODEX_METRICS
# target:
# type: environment
# name: CODEX_METRICS
# service: codex-node
# title: CODEX_METRICS
# description: >-
# Enable the metrics server, default = `false`.
# enum:
# - "true"
# - "false"
# required: false
- id: CODEX_STORAGE_QUOTA
target:
type: environment
name: CODEX_STORAGE_QUOTA
service: codex-node
title: CODEX_STORAGE_QUOTA
description: >-
The size of the total storage quota dedicated to the node, default = `8gb`. Accept common units like kb, mb, gb, tb.
pattern: "^[0-9A-Za-z]+$"
patternErrorMessage: Must be a valid storage quota value - number with an optional unit
required: true
- id: CODEX_BLOCK_TTL
target:
type: environment
name: CODEX_BLOCK_TTL
service: codex-node
title: CODEX_BLOCK_TTL
description: >-
Default block timeout in seconds - 0 disables the ttl, default `24h`. Accept common units like s, h, d, w.
pattern: "^[0-9A-Za-z]+$"
patternErrorMessage: Must be a valid block timeout - number with an optional unit
required: true
- id: CODEX_LOG_LEVEL
target:
type: environment
name: CODEX_LOG_LEVEL
service: codex-node
title: CODEX_LOG_LEVEL
description: >-
Sets the log level, default = `info`. Available options: `info`, `warn`, `error`, `debug`, `trace`. Check the [docs](https://docs.codex.storage/learn/run#logging) for more details.
pattern: "^[A-Za-z-,;:]+$"
patternErrorMessage: Must be a valid log level
required: true
- id: CODEX_API_PORT
target:
type: environment
name: CODEX_API_PORT
service: codex-node
title: CODEX_API_PORT
description: >-
The REST API port, default = `8080`.
pattern: "^((6553[0-5])|(655[0-2][0-9])|(65[0-4][0-9]{2})|(6[0-4][0-9]{3})|([1-5][0-9]{4})|([0-5]{0,5})|([0][0-9]{1,4})|([0-9]{1,4}))$"
patternErrorMessage: Must be a valid port number
required: false
- id: CODEX_DISC_PORT
target:
type: environment
name: CODEX_DISC_PORT
service: codex-node
title: CODEX_DISC_PORT
description: >-
Discovery (UDP) port, default = `8090`.
pattern: "^((6553[0-5])|(655[0-2][0-9])|(65[0-4][0-9]{2})|(6[0-4][0-9]{3})|([1-5][0-9]{4})|([0-5]{0,5})|([0][0-9]{1,4})|([0-9]{1,4}))$"
patternErrorMessage: Must be a valid port number
required: false
- id: EXTRA_OPTS
target:
type: environment
name: EXTRA_OPTS
service: codex-node
title: EXTRA_OPTS
description: >-
Extra options to pass to the Codex node. Check [Codex CLI options](https://docs.codex.storage/learn/run#cli-options) for more details.
pattern: "^.*$"
patternErrorMessage: Must be a valid string
required: false
- id: portMapping_CODEX_LISTEN_ADDRS
target:
type: portMapping
containerPort: 8070/TCP
service: codex-node
title: Port mapping for Codex Node - CODEX_LISTEN_ADDRS
description: >-
Transport (TCP) port, default = `8070`.
pattern: "^((6553[0-5])|(655[0-2][0-9])|(65[0-4][0-9]{2})|(6[0-4][0-9]{3})|([1-5][0-9]{4})|([0-5]{0,5})|([0][0-9]{1,4})|([0-9]{1,4}))$"
patternErrorMessage: Must be a valid port number
required: true
- id: portMapping_CODEX_DISC_PORT
target:
type: portMapping
containerPort: 8090/UDP
service: codex-node
title: Port mapping for Codex Node - CODEX_DISC_PORT
description: >-
Discovery (UDP) port, default = `8090`.
pattern: "^((6553[0-5])|(655[0-2][0-9])|(65[0-4][0-9]{2})|(6[0-4][0-9]{3})|([1-5][0-9]{4})|([0-5]{0,5})|([0][0-9]{1,4})|([0-9]{1,4}))$"
patternErrorMessage: Must be a valid port number
required: true