API tools faq
paste
Cleric-K

Untitled

Cleric-K
Mar 27th, 2026
38
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 18.73 KB | None | 0 0
raw download clone embed print report
  1. {
  2. "$schema": "https://json-schema.org/draft/2020-12/schema",
  3. "title": "Config",
  4. "description": "Local radicle configuration.",
  5. "type": "object",
  6. "properties": {
  7. "publicExplorer": {
  8. "description": "Public explorer. This is used for generating links.",
  9. "$ref": "#/$defs/Explorer",
  10. "default": "https://app.radicle.xyz/nodes/$host/$rid$path"
  11. },
  12. "preferredSeeds": {
  13. "description": "Preferred seeds. These seeds will be used for explorer links\nand in other situations when a seed needs to be chosen.",
  14. "type": "array",
  15. "items": {
  16. "$ref": "#/$defs/ConnectAddress"
  17. },
  18. "default": []
  19. },
  20. "web": {
  21. "description": "Web configuration.",
  22. "$ref": "#/$defs/WebConfig",
  23. "default": {
  24. "pinned": {
  25. "repositories": []
  26. }
  27. }
  28. },
  29. "cli": {
  30. "description": "CLI configuration.",
  31. "$ref": "#/$defs/CliConfig",
  32. "default": {
  33. "hints": true
  34. }
  35. },
  36. "node": {
  37. "description": "Node configuration.",
  38. "$ref": "#/$defs/NodeConfig"
  39. }
  40. },
  41. "required": [
  42. "node"
  43. ],
  44. "$defs": {
  45. "Explorer": {
  46. "description": "A public explorer.",
  47. "type": "string"
  48. },
  49. "ConnectAddress": {
  50. "description": "A node address to connect to. Format: An Ed25519 public key in multibase encoding, followed by the symbol '@', followed by an IP address, or a DNS name, or a Tor onion name, followed by the symbol ':', followed by a TCP port number.",
  51. "type": "string",
  52. "examples": [
  53. "z6MkrLMMsiPWUcNPHcRajuMi9mDfYckSoJyPwwnknocNYPm7@rosa.radicle.xyz:8776",
  54. "z6MkvUJtYD9dHDJfpevWRT98mzDDpdAtmUjwyDSkyqksUr7C@xmrhfasfg5suueegrnc4gsgyi2tyclcy5oz7f5drnrodmdtob6t2ioyd.onion:8776",
  55. "z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi@seed.example.com:8776",
  56. "[email protected]:31337"
  57. ],
  58. "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-9]{1,4}))$"
  59. },
  60. "WebConfig": {
  61. "description": "Web configuration.",
  62. "type": "object",
  63. "properties": {
  64. "pinned": {
  65. "description": "Pinned content.",
  66. "$ref": "#/$defs/Pinned"
  67. },
  68. "bannerUrl": {
  69. "description": "URL pointing to an image used in the header of a node page.",
  70. "type": [
  71. "string",
  72. "null"
  73. ],
  74. "format": "uri"
  75. },
  76. "avatarUrl": {
  77. "description": "URL pointing to an image used as the node avatar.",
  78. "type": [
  79. "string",
  80. "null"
  81. ],
  82. "format": "uri"
  83. },
  84. "description": {
  85. "description": "Node description.",
  86. "type": [
  87. "string",
  88. "null"
  89. ],
  90. "format": "uri"
  91. }
  92. },
  93. "required": [
  94. "pinned"
  95. ]
  96. },
  97. "Pinned": {
  98. "description": "Pinned content. This can be used to pin certain content when\nlisting, e.g. pin repositories on a web client.",
  99. "type": "object",
  100. "properties": {
  101. "repositories": {
  102. "description": "Pinned repositories.",
  103. "type": "array",
  104. "uniqueItems": true,
  105. "items": {
  106. "$ref": "#/$defs/RepoId"
  107. }
  108. }
  109. },
  110. "required": [
  111. "repositories"
  112. ]
  113. },
  114. "RepoId": {
  115. "description": "A repository identifier.",
  116. "type": "string",
  117. "examples": [
  118. "rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5"
  119. ],
  120. "minLength": 5,
  121. "pattern": "rad:z[1-9a-km-zA-HJ-NP-Z]+"
  122. },
  123. "CliConfig": {
  124. "description": "CLI configuration.",
  125. "type": "object",
  126. "properties": {
  127. "hints": {
  128. "description": "Whether to show hints or not in the CLI.",
  129. "type": "boolean",
  130. "default": false
  131. }
  132. }
  133. },
  134. "NodeConfig": {
  135. "description": "Service configuration.",
  136. "type": "object",
  137. "properties": {
  138. "alias": {
  139. "description": "Node alias.",
  140. "$ref": "#/$defs/Alias"
  141. },
  142. "listen": {
  143. "description": "Socket address (a combination of IPv4 or IPv6 address and TCP port) to listen on.",
  144. "type": "array",
  145. "items": {
  146. "type": "string"
  147. },
  148. "examples": [
  149. "127.0.0.1:8776"
  150. ],
  151. "default": []
  152. },
  153. "peers": {
  154. "description": "Peer configuration.",
  155. "$ref": "#/$defs/PeerConfig",
  156. "default": {
  157. "type": "dynamic"
  158. }
  159. },
  160. "connect": {
  161. "description": "Peers to connect to on startup.\nConnections to these peers will be maintained.",
  162. "type": "array",
  163. "uniqueItems": true,
  164. "items": {
  165. "$ref": "#/$defs/ConnectAddress"
  166. },
  167. "default": []
  168. },
  169. "externalAddresses": {
  170. "description": "Specify the node's public addresses",
  171. "type": "array",
  172. "items": {
  173. "$ref": "#/$defs/Address"
  174. },
  175. "default": []
  176. },
  177. "proxy": {
  178. "description": "Global proxy.",
  179. "type": [
  180. "string",
  181. "null"
  182. ]
  183. },
  184. "onion": {
  185. "description": "Onion address config.",
  186. "anyOf": [
  187. {
  188. "$ref": "#/$defs/AddressConfig"
  189. },
  190. {
  191. "type": "null"
  192. }
  193. ]
  194. },
  195. "network": {
  196. "description": "Peer-to-peer network.",
  197. "$ref": "#/$defs/Network",
  198. "default": "main"
  199. },
  200. "log": {
  201. "description": "Log level.",
  202. "$ref": "#/$defs/LogLevel",
  203. "default": "INFO"
  204. },
  205. "relay": {
  206. "description": "Whether or not our node should relay messages.",
  207. "$ref": "#/$defs/Relay",
  208. "default": "auto"
  209. },
  210. "limits": {
  211. "description": "Configured service limits.",
  212. "$ref": "#/$defs/Limits",
  213. "default": {
  214. "routingMaxSize": 1000,
  215. "routingMaxAge": 604800,
  216. "gossipMaxAge": 1209600,
  217. "fetchConcurrency": 1,
  218. "maxOpenFiles": 4096,
  219. "rate": {
  220. "inbound": {
  221. "fillRate": 5.0,
  222. "capacity": 1024
  223. },
  224. "outbound": {
  225. "fillRate": 10.0,
  226. "capacity": 2048
  227. }
  228. },
  229. "connection": {
  230. "inbound": 128,
  231. "outbound": 16
  232. },
  233. "fetchPackReceive": "500.0 MiB"
  234. }
  235. },
  236. "workers": {
  237. "description": "Number of worker threads to spawn.",
  238. "type": "integer",
  239. "format": "uint",
  240. "minimum": 0,
  241. "default": 8
  242. },
  243. "seedingPolicy": {
  244. "description": "Default seeding policy.",
  245. "$ref": "#/$defs/DefaultSeedingPolicy",
  246. "default": {
  247. "default": "block"
  248. }
  249. },
  250. "database": {
  251. "description": "Database configuration.",
  252. "$ref": "#/$defs/Config"
  253. },
  254. "secret": {
  255. "description": "Path to a file containing an Ed25519 secret key, in OpenSSH format, i.e.\nwith the `-----BEGIN OPENSSH PRIVATE KEY-----` header. The corresponding\npublic key will be used as the Node ID.\n\nA decryption password cannot be configured, but passed at runtime via\nthe environment variable `RAD_PASSPHRASE`.",
  256. "type": [
  257. "string",
  258. "null"
  259. ]
  260. }
  261. },
  262. "required": [
  263. "alias"
  264. ],
  265. "additionalProperties": true
  266. },
  267. "Alias": {
  268. "description": "Node alias, i.e. a short and memorable name for it.",
  269. "type": "string"
  270. },
  271. "PeerConfig": {
  272. "description": "Peer configuration.",
  273. "oneOf": [
  274. {
  275. "description": "Static peer set. Connect to the configured peers and maintain the connections.",
  276. "type": "object",
  277. "properties": {
  278. "type": {
  279. "type": "string",
  280. "const": "static"
  281. }
  282. },
  283. "required": [
  284. "type"
  285. ]
  286. },
  287. {
  288. "description": "Dynamic peer set.",
  289. "type": "object",
  290. "properties": {
  291. "type": {
  292. "type": "string",
  293. "const": "dynamic"
  294. }
  295. },
  296. "required": [
  297. "type"
  298. ]
  299. }
  300. ]
  301. },
  302. "Address": {
  303. "description": "An IP address, or a DNS name, or a Tor onion name, followed by the symbol ':', followed by a TCP port number.",
  304. "type": "string",
  305. "examples": [
  306. "xmrhfasfg5suueegrnc4gsgyi2tyclcy5oz7f5drnrodmdtob6t2ioyd.onion:8776",
  307. "seed.example.com:8776",
  308. "192.0.2.0:31337"
  309. ],
  310. "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-9]{1,4}))$"
  311. },
  312. "AddressConfig": {
  313. "description": "Proxy configuration.",
  314. "oneOf": [
  315. {
  316. "description": "Proxy connections to this address type.",
  317. "type": "object",
  318. "properties": {
  319. "address": {
  320. "description": "Proxy address.",
  321. "type": "string"
  322. },
  323. "mode": {
  324. "type": "string",
  325. "const": "proxy"
  326. }
  327. },
  328. "required": [
  329. "mode",
  330. "address"
  331. ]
  332. },
  333. {
  334. "description": "Forward address to the next layer. Either this is the global proxy,\nor the operating system, via DNS.",
  335. "type": "object",
  336. "properties": {
  337. "mode": {
  338. "type": "string",
  339. "const": "forward"
  340. }
  341. },
  342. "required": [
  343. "mode"
  344. ]
  345. }
  346. ]
  347. },
  348. "Network": {
  349. "description": "Peer-to-peer network.",
  350. "type": "string",
  351. "enum": [
  352. "main",
  353. "test"
  354. ]
  355. },
  356. "LogLevel": {
  357. "$ref": "#/$defs/Level"
  358. },
  359. "Level": {
  360. "description": "A log level.",
  361. "oneOf": [
  362. {
  363. "description": "Designates very serious errors.",
  364. "type": "string",
  365. "const": "ERROR"
  366. },
  367. {
  368. "description": "Designates hazardous situations.",
  369. "type": "string",
  370. "const": "WARN"
  371. },
  372. {
  373. "description": "Designates useful information.",
  374. "type": "string",
  375. "const": "INFO"
  376. },
  377. {
  378. "description": "Designates lower priority information.",
  379. "type": "string",
  380. "const": "DEBUG"
  381. },
  382. {
  383. "description": "Designates very low priority, often extremely verbose, information.",
  384. "type": "string",
  385. "const": "TRACE"
  386. }
  387. ]
  388. },
  389. "Relay": {
  390. "description": "Relay configuration.",
  391. "oneOf": [
  392. {
  393. "description": "Always relay messages.",
  394. "type": "string",
  395. "const": "always"
  396. },
  397. {
  398. "description": "Never relay messages.",
  399. "type": "string",
  400. "const": "never"
  401. },
  402. {
  403. "description": "Relay messages when applicable.",
  404. "type": "string",
  405. "const": "auto"
  406. }
  407. ]
  408. },
  409. "Limits": {
  410. "description": "Configuration parameters defining attributes of minima and maxima.",
  411. "type": "object",
  412. "properties": {
  413. "routingMaxSize": {
  414. "description": "Number of routing table entries before we start pruning.",
  415. "type": "integer",
  416. "format": "uint",
  417. "minimum": 0,
  418. "default": 1000
  419. },
  420. "routingMaxAge": {
  421. "description": "How long to keep a routing table entry before being pruned.",
  422. "$ref": "#/$defs/LocalDuration",
  423. "default": 604800
  424. },
  425. "gossipMaxAge": {
  426. "description": "How long to keep a gossip message entry before pruning it.",
  427. "$ref": "#/$defs/LocalDuration",
  428. "default": 1209600
  429. },
  430. "fetchConcurrency": {
  431. "description": "Maximum number of concurrent fetches per peer connection.",
  432. "type": "integer",
  433. "format": "uint",
  434. "minimum": 0,
  435. "default": 1
  436. },
  437. "maxOpenFiles": {
  438. "description": "Maximum number of open files.",
  439. "type": "integer",
  440. "format": "uint",
  441. "minimum": 0,
  442. "default": 4096
  443. },
  444. "rate": {
  445. "description": "Rate limiter settings.",
  446. "$ref": "#/$defs/RateLimits",
  447. "default": {
  448. "inbound": {
  449. "fillRate": 5.0,
  450. "capacity": 1024
  451. },
  452. "outbound": {
  453. "fillRate": 10.0,
  454. "capacity": 2048
  455. }
  456. }
  457. },
  458. "connection": {
  459. "description": "Connection limits.",
  460. "$ref": "#/$defs/ConnectionLimits",
  461. "default": {
  462. "inbound": 128,
  463. "outbound": 16
  464. }
  465. },
  466. "fetchPackReceive": {
  467. "description": "Channel limits.",
  468. "$ref": "#/$defs/FetchPackSizeLimit",
  469. "default": "500.0 MiB"
  470. }
  471. }
  472. },
  473. "LocalDuration": {
  474. "description": "A time duration measured locally in seconds.",
  475. "type": "integer",
  476. "format": "uint128",
  477. "minimum": 0
  478. },
  479. "RateLimits": {
  480. "description": "Rate limits for inbound and outbound connections.",
  481. "type": "object",
  482. "properties": {
  483. "inbound": {
  484. "$ref": "#/$defs/RateLimit"
  485. },
  486. "outbound": {
  487. "$ref": "#/$defs/RateLimit"
  488. }
  489. },
  490. "required": [
  491. "inbound",
  492. "outbound"
  493. ]
  494. },
  495. "RateLimit": {
  496. "description": "Rate limits for a single connection.",
  497. "type": "object",
  498. "properties": {
  499. "fillRate": {
  500. "type": "number",
  501. "format": "double"
  502. },
  503. "capacity": {
  504. "type": "integer",
  505. "format": "uint",
  506. "minimum": 0
  507. }
  508. },
  509. "required": [
  510. "fillRate",
  511. "capacity"
  512. ]
  513. },
  514. "ConnectionLimits": {
  515. "description": "Connection limits.",
  516. "type": "object",
  517. "properties": {
  518. "inbound": {
  519. "description": "Max inbound connections.",
  520. "type": "integer",
  521. "format": "uint",
  522. "minimum": 0,
  523. "default": 128
  524. },
  525. "outbound": {
  526. "description": "Max outbound connections. Note that this can be higher than the *target* number.",
  527. "type": "integer",
  528. "format": "uint",
  529. "minimum": 0,
  530. "default": 16
  531. }
  532. }
  533. },
  534. "FetchPackSizeLimit": {
  535. "description": "Limiter for byte streams.\n\nDefault: 500MiB",
  536. "$ref": "#/$defs/ByteSize"
  537. },
  538. "ByteSize": {
  539. "description": "Byte quantities using unit prefixes according to SI or ISO/IEC 80000-13.",
  540. "type": "string",
  541. "pattern": "^\\d+(\\.\\d+)? ((K|M|G|T|P)i?B?|B)$",
  542. "examples": [
  543. "7 G",
  544. "50.3 TiB",
  545. "200 B",
  546. "4 Ki",
  547. "10 MB"
  548. ]
  549. },
  550. "DefaultSeedingPolicy": {
  551. "description": "Default seeding policy. Applies when no repository policies for the given repo are found.",
  552. "oneOf": [
  553. {
  554. "description": "Allow seeding.",
  555. "type": "object",
  556. "properties": {
  557. "default": {
  558. "type": "string",
  559. "const": "allow"
  560. }
  561. },
  562. "anyOf": [
  563. {
  564. "$ref": "#/$defs/Scope"
  565. },
  566. {
  567. "type": "null"
  568. }
  569. ],
  570. "required": [
  571. "default"
  572. ]
  573. },
  574. {
  575. "description": "Block seeding.",
  576. "type": "object",
  577. "properties": {
  578. "default": {
  579. "type": "string",
  580. "const": "block"
  581. }
  582. },
  583. "required": [
  584. "default"
  585. ]
  586. }
  587. ]
  588. },
  589. "Scope": {
  590. "description": "Follow scope of a seeded repository.",
  591. "oneOf": [
  592. {
  593. "description": "Seed remotes that are explicitly followed.",
  594. "type": "string",
  595. "const": "followed"
  596. },
  597. {
  598. "description": "Seed all remotes.",
  599. "type": "string",
  600. "const": "all"
  601. }
  602. ]
  603. },
  604. "Config": {
  605. "description": "Database configuration.",
  606. "type": "object",
  607. "properties": {
  608. "sqlite": {
  609. "description": "SQLite configuration.",
  610. "$ref": "#/$defs/SqliteConfig"
  611. }
  612. },
  613. "required": [
  614. "sqlite"
  615. ]
  616. },
  617. "SqliteConfig": {
  618. "description": "SQLite database configuration.",
  619. "type": "object",
  620. "properties": {
  621. "pragma": {
  622. "$ref": "#/$defs/Pragma"
  623. }
  624. }
  625. },
  626. "Pragma": {
  627. "description": "Global SQLite pragma statements to make in order to configure SQLite itself,\nsee <https://sqlite.org/pragma.html>.",
  628. "type": "object",
  629. "properties": {
  630. "journalMode": {
  631. "$ref": "#/$defs/JournalMode"
  632. },
  633. "synchronous": {
  634. "$ref": "#/$defs/Synchronous"
  635. }
  636. }
  637. },
  638. "JournalMode": {
  639. "description": "Value for a `journal_mode` pragma statement.\nFor a description of all variants please refer to\n<https://sqlite.org/pragma.html#pragma_journal_mode>.\nNote that when SQLite documentation talks about \"the application\",\nthe application linked against this crate, e.g. Radicle Node, Radicle CLI,\nand others, is meant.",
  640. "type": "string",
  641. "enum": [
  642. "DELETE",
  643. "TRUNCATE",
  644. "PERSIST",
  645. "MEMORY",
  646. "WAL",
  647. "OFF"
  648. ]
  649. },
  650. "Synchronous": {
  651. "description": "Value for a `synchronous` pragma statement.\nFor a description of all variants please refer to\n<https://sqlite.org/pragma.html#pragma_synchronous>.",
  652. "type": "string",
  653. "enum": [
  654. "EXTRA",
  655. "FULL",
  656. "NORMAL",
  657. "OFF"
  658. ]
  659. }
  660. }
  661. }
Add Comment
Please, Sign In to add comment
Public Pastes
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!