app_versions.json 106 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363
  1. {
  2. "1.0.31": {
  3. "healthy": true,
  4. "supported": false,
  5. "healthy_error": null,
  6. "location": "/__w/charts/charts/community/audiobookshelf/1.0.31",
  7. "last_update": "2025-03-05 14:27:33",
  8. "required_features": [
  9. "normalize/ixVolume",
  10. "definitions/timezone",
  11. "normalize/acl"
  12. ],
  13. "human_version": "2.19.5_1.0.31",
  14. "version": "1.0.31",
  15. "chart_metadata": {
  16. "name": "audiobookshelf",
  17. "description": "Audiobookshelf is a self-hosted audiobook and podcast server",
  18. "annotations": {
  19. "title": "Audiobookshelf"
  20. },
  21. "type": "application",
  22. "version": "1.0.31",
  23. "apiVersion": "v2",
  24. "appVersion": "2.19.5",
  25. "kubeVersion": ">=1.16.0-0",
  26. "maintainers": [
  27. {
  28. "name": "truenas",
  29. "url": "https://www.truenas.com/",
  30. "email": "dev@ixsystems.com"
  31. }
  32. ],
  33. "dependencies": [
  34. {
  35. "name": "common",
  36. "repository": "file://../../../common",
  37. "version": "1.2.9"
  38. }
  39. ],
  40. "home": "https://www.audiobookshelf.org/",
  41. "icon": "https://media.sys.truenas.net/apps/audiobookshelf/icons/icon.svg",
  42. "sources": [
  43. "https://ghcr.io/advplyr/audiobookshelf",
  44. "https://github.com/truenas/charts/tree/master/library/ix-dev/community/audiobookshelf",
  45. "https://github.com/advplyr/audiobookshelf"
  46. ],
  47. "keywords": [
  48. "media",
  49. "audiobook"
  50. ]
  51. },
  52. "app_metadata": {
  53. "runAsContext": [
  54. {
  55. "userName": "audiobookshelf",
  56. "groupName": "audiobookshelf",
  57. "gid": 568,
  58. "uid": 568,
  59. "description": "Audiobookshelf can run as any non-root user."
  60. }
  61. ],
  62. "capabilities": [],
  63. "hostMounts": []
  64. },
  65. "schema": {
  66. "groups": [
  67. {
  68. "name": "Audiobookshelf Configuration",
  69. "description": "Configure Audiobookshelf"
  70. },
  71. {
  72. "name": "User and Group Configuration",
  73. "description": "Configure User and Group for Audiobookshelf"
  74. },
  75. {
  76. "name": "Network Configuration",
  77. "description": "Configure Network for Audiobookshelf"
  78. },
  79. {
  80. "name": "Storage Configuration",
  81. "description": "Configure Storage for Audiobookshelf"
  82. },
  83. {
  84. "name": "Resources Configuration",
  85. "description": "Configure Resources for Audiobookshelf"
  86. }
  87. ],
  88. "portals": {
  89. "web_portal": {
  90. "protocols": [
  91. "$kubernetes-resource_configmap_portal_protocol"
  92. ],
  93. "host": [
  94. "$kubernetes-resource_configmap_portal_host"
  95. ],
  96. "ports": [
  97. "$kubernetes-resource_configmap_portal_port"
  98. ],
  99. "path": "$kubernetes-resource_configmap_portal_path"
  100. }
  101. },
  102. "questions": [
  103. {
  104. "variable": "TZ",
  105. "group": "Audiobookshelf Configuration",
  106. "label": "Timezone",
  107. "schema": {
  108. "type": "string",
  109. "default": "America/Los_Angeles",
  110. "required": true,
  111. "$ref": [
  112. "definitions/timezone"
  113. ],
  114. "enum": [
  115. {
  116. "value": "Asia/Damascus",
  117. "description": "'Asia/Damascus' timezone"
  118. },
  119. {
  120. "value": "Asia/Saigon",
  121. "description": "'Asia/Saigon' timezone"
  122. }
  123. ]
  124. }
  125. },
  126. {
  127. "variable": "audiobookshelfConfig",
  128. "label": "",
  129. "group": "Audiobookshelf Configuration",
  130. "schema": {
  131. "type": "dict",
  132. "attrs": [
  133. {
  134. "variable": "additionalEnvs",
  135. "label": "Additional Environment Variables",
  136. "description": "Configure additional environment variables for Audiobookshelf.",
  137. "schema": {
  138. "type": "list",
  139. "default": [],
  140. "items": [
  141. {
  142. "variable": "env",
  143. "label": "Environment Variable",
  144. "schema": {
  145. "type": "dict",
  146. "attrs": [
  147. {
  148. "variable": "name",
  149. "label": "Name",
  150. "schema": {
  151. "type": "string",
  152. "required": true
  153. }
  154. },
  155. {
  156. "variable": "value",
  157. "label": "Value",
  158. "schema": {
  159. "type": "string",
  160. "required": true
  161. }
  162. }
  163. ]
  164. }
  165. }
  166. ]
  167. }
  168. }
  169. ]
  170. }
  171. },
  172. {
  173. "variable": "audiobookshelfRunAs",
  174. "label": "",
  175. "group": "User and Group Configuration",
  176. "schema": {
  177. "type": "dict",
  178. "attrs": [
  179. {
  180. "variable": "user",
  181. "label": "User ID",
  182. "description": "The user id that Audiobookshelf will run as.",
  183. "schema": {
  184. "type": "int",
  185. "min": 2,
  186. "default": 568,
  187. "required": true
  188. }
  189. },
  190. {
  191. "variable": "group",
  192. "label": "Group ID",
  193. "description": "The group id that Audiobookshelf will run as.",
  194. "schema": {
  195. "type": "int",
  196. "min": 2,
  197. "default": 568,
  198. "required": true
  199. }
  200. }
  201. ]
  202. }
  203. },
  204. {
  205. "variable": "audiobookshelfNetwork",
  206. "label": "",
  207. "group": "Network Configuration",
  208. "schema": {
  209. "type": "dict",
  210. "attrs": [
  211. {
  212. "variable": "webPort",
  213. "label": "Web Port",
  214. "description": "The port for the Audiobookshelf Web UI.",
  215. "schema": {
  216. "type": "int",
  217. "default": 30067,
  218. "min": 9000,
  219. "max": 65535,
  220. "required": true
  221. }
  222. },
  223. {
  224. "variable": "hostNetwork",
  225. "label": "Host Network",
  226. "description": "Bind to the host network. It's recommended to keep this disabled.</br>\n",
  227. "schema": {
  228. "type": "boolean",
  229. "default": false
  230. }
  231. }
  232. ]
  233. }
  234. },
  235. {
  236. "variable": "audiobookshelfStorage",
  237. "label": "",
  238. "group": "Storage Configuration",
  239. "schema": {
  240. "type": "dict",
  241. "attrs": [
  242. {
  243. "variable": "config",
  244. "label": "Audiobookshelf Config Storage",
  245. "description": "The path to store Audiobookshelf Configuration and Database.",
  246. "schema": {
  247. "type": "dict",
  248. "attrs": [
  249. {
  250. "variable": "type",
  251. "label": "Type",
  252. "description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.\n",
  253. "schema": {
  254. "type": "string",
  255. "required": true,
  256. "immutable": true,
  257. "default": "ixVolume",
  258. "enum": [
  259. {
  260. "value": "hostPath",
  261. "description": "Host Path (Path that already exists on the system)"
  262. },
  263. {
  264. "value": "ixVolume",
  265. "description": "ixVolume (Dataset created automatically by the system)"
  266. }
  267. ]
  268. }
  269. },
  270. {
  271. "variable": "ixVolumeConfig",
  272. "label": "ixVolume Configuration",
  273. "description": "The configuration for the ixVolume dataset.",
  274. "schema": {
  275. "type": "dict",
  276. "show_if": [
  277. [
  278. "type",
  279. "=",
  280. "ixVolume"
  281. ]
  282. ],
  283. "$ref": [
  284. "normalize/ixVolume"
  285. ],
  286. "attrs": [
  287. {
  288. "variable": "aclEnable",
  289. "label": "Enable ACL",
  290. "description": "Enable ACL for the dataset.",
  291. "schema": {
  292. "type": "boolean",
  293. "default": false
  294. }
  295. },
  296. {
  297. "variable": "datasetName",
  298. "label": "Dataset Name",
  299. "description": "The name of the dataset to use for storage.",
  300. "schema": {
  301. "type": "string",
  302. "required": true,
  303. "immutable": true,
  304. "hidden": true,
  305. "default": "config"
  306. }
  307. },
  308. {
  309. "variable": "aclEntries",
  310. "label": "ACL Configuration",
  311. "schema": {
  312. "type": "dict",
  313. "show_if": [
  314. [
  315. "aclEnable",
  316. "=",
  317. true
  318. ]
  319. ],
  320. "attrs": [
  321. {
  322. "variable": "path",
  323. "label": "Path",
  324. "description": "Path to perform ACL",
  325. "schema": {
  326. "type": "string",
  327. "hidden": true
  328. }
  329. },
  330. {
  331. "variable": "entries",
  332. "label": "ACL Entries",
  333. "description": "ACL Entries",
  334. "schema": {
  335. "type": "list",
  336. "items": [
  337. {
  338. "variable": "aclEntry",
  339. "label": "ACL Entry",
  340. "schema": {
  341. "type": "dict",
  342. "attrs": [
  343. {
  344. "variable": "id_type",
  345. "label": "ID Type",
  346. "schema": {
  347. "type": "string",
  348. "enum": [
  349. {
  350. "value": "USER",
  351. "description": "Entry is for a USER"
  352. },
  353. {
  354. "value": "GROUP",
  355. "description": "Entry is for a GROUP"
  356. }
  357. ],
  358. "default": "USER"
  359. }
  360. },
  361. {
  362. "variable": "id",
  363. "label": "ID",
  364. "description": "Make sure to check the ID value is correct and aligns with RunAs user context of the application",
  365. "schema": {
  366. "type": "int",
  367. "required": true,
  368. "min": 0
  369. }
  370. },
  371. {
  372. "variable": "access",
  373. "label": "Access",
  374. "schema": {
  375. "type": "string",
  376. "enum": [
  377. {
  378. "value": "READ",
  379. "description": "Read Access"
  380. },
  381. {
  382. "value": "MODIFY",
  383. "description": "Modify Access"
  384. },
  385. {
  386. "value": "FULL_CONTROL",
  387. "description": "FULL_CONTROL Access"
  388. }
  389. ]
  390. }
  391. }
  392. ]
  393. }
  394. }
  395. ]
  396. }
  397. }
  398. ]
  399. }
  400. }
  401. ]
  402. }
  403. },
  404. {
  405. "variable": "hostPathConfig",
  406. "label": "Host Path Configuration",
  407. "schema": {
  408. "type": "dict",
  409. "show_if": [
  410. [
  411. "type",
  412. "=",
  413. "hostPath"
  414. ]
  415. ],
  416. "attrs": [
  417. {
  418. "variable": "aclEnable",
  419. "label": "Enable ACL",
  420. "description": "Enable ACL for the dataset.",
  421. "schema": {
  422. "type": "boolean",
  423. "default": false
  424. }
  425. },
  426. {
  427. "variable": "acl",
  428. "label": "ACL Configuration",
  429. "schema": {
  430. "type": "dict",
  431. "show_if": [
  432. [
  433. "aclEnable",
  434. "=",
  435. true
  436. ]
  437. ],
  438. "attrs": [
  439. {
  440. "variable": "path",
  441. "label": "Host Path",
  442. "description": "Host Path to perform ACL",
  443. "schema": {
  444. "type": "hostpath",
  445. "required": true,
  446. "empty": false
  447. }
  448. },
  449. {
  450. "variable": "entries",
  451. "label": "ACL Entries",
  452. "description": "ACL Entries",
  453. "schema": {
  454. "type": "list",
  455. "items": [
  456. {
  457. "variable": "aclEntry",
  458. "label": "ACL Entry",
  459. "schema": {
  460. "type": "dict",
  461. "attrs": [
  462. {
  463. "variable": "id_type",
  464. "label": "ID Type",
  465. "schema": {
  466. "type": "string",
  467. "enum": [
  468. {
  469. "value": "USER",
  470. "description": "Entry is for a USER"
  471. },
  472. {
  473. "value": "GROUP",
  474. "description": "Entry is for a GROUP"
  475. }
  476. ],
  477. "default": "USER"
  478. }
  479. },
  480. {
  481. "variable": "id",
  482. "label": "ID",
  483. "description": "Make sure to check the ID value is correct and aligns with RunAs user context of the application",
  484. "schema": {
  485. "type": "int",
  486. "required": true,
  487. "min": 0
  488. }
  489. },
  490. {
  491. "variable": "access",
  492. "label": "Access",
  493. "schema": {
  494. "type": "string",
  495. "enum": [
  496. {
  497. "value": "READ",
  498. "description": "Read Access"
  499. },
  500. {
  501. "value": "MODIFY",
  502. "description": "Modify Access"
  503. },
  504. {
  505. "value": "FULL_CONTROL",
  506. "description": "FULL_CONTROL Access"
  507. }
  508. ]
  509. }
  510. }
  511. ]
  512. }
  513. }
  514. ]
  515. }
  516. },
  517. {
  518. "variable": "options",
  519. "label": "ACL Options",
  520. "schema": {
  521. "type": "dict",
  522. "attrs": [
  523. {
  524. "variable": "force",
  525. "label": "Force Flag",
  526. "description": "Enabling `Force` applies ACL even if the path has existing data",
  527. "schema": {
  528. "type": "boolean",
  529. "default": false
  530. }
  531. }
  532. ]
  533. }
  534. }
  535. ],
  536. "$ref": [
  537. "normalize/acl"
  538. ]
  539. }
  540. },
  541. {
  542. "variable": "hostPath",
  543. "label": "Host Path",
  544. "description": "The host path to use for storage.",
  545. "schema": {
  546. "type": "hostpath",
  547. "show_if": [
  548. [
  549. "aclEnable",
  550. "=",
  551. false
  552. ]
  553. ],
  554. "required": true
  555. }
  556. }
  557. ]
  558. }
  559. }
  560. ]
  561. }
  562. },
  563. {
  564. "variable": "metadata",
  565. "label": "Audiobookshelf Metadata Storage",
  566. "description": "The path to store Audiobookshelf cache, streams, covers, downloads, backups and logs.",
  567. "schema": {
  568. "type": "dict",
  569. "attrs": [
  570. {
  571. "variable": "type",
  572. "label": "Type",
  573. "description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.\n",
  574. "schema": {
  575. "type": "string",
  576. "required": true,
  577. "immutable": true,
  578. "default": "ixVolume",
  579. "enum": [
  580. {
  581. "value": "hostPath",
  582. "description": "Host Path (Path that already exists on the system)"
  583. },
  584. {
  585. "value": "ixVolume",
  586. "description": "ixVolume (Dataset created automatically by the system)"
  587. }
  588. ]
  589. }
  590. },
  591. {
  592. "variable": "ixVolumeConfig",
  593. "label": "ixVolume Configuration",
  594. "description": "The configuration for the ixVolume dataset.",
  595. "schema": {
  596. "type": "dict",
  597. "show_if": [
  598. [
  599. "type",
  600. "=",
  601. "ixVolume"
  602. ]
  603. ],
  604. "$ref": [
  605. "normalize/ixVolume"
  606. ],
  607. "attrs": [
  608. {
  609. "variable": "aclEnable",
  610. "label": "Enable ACL",
  611. "description": "Enable ACL for the dataset.",
  612. "schema": {
  613. "type": "boolean",
  614. "default": false
  615. }
  616. },
  617. {
  618. "variable": "datasetName",
  619. "label": "Dataset Name",
  620. "description": "The name of the dataset to use for storage.",
  621. "schema": {
  622. "type": "string",
  623. "required": true,
  624. "immutable": true,
  625. "hidden": true,
  626. "default": "metadata"
  627. }
  628. },
  629. {
  630. "variable": "aclEntries",
  631. "label": "ACL Configuration",
  632. "schema": {
  633. "type": "dict",
  634. "show_if": [
  635. [
  636. "aclEnable",
  637. "=",
  638. true
  639. ]
  640. ],
  641. "attrs": [
  642. {
  643. "variable": "path",
  644. "label": "Path",
  645. "description": "Path to perform ACL",
  646. "schema": {
  647. "type": "string",
  648. "hidden": true
  649. }
  650. },
  651. {
  652. "variable": "entries",
  653. "label": "ACL Entries",
  654. "description": "ACL Entries",
  655. "schema": {
  656. "type": "list",
  657. "items": [
  658. {
  659. "variable": "aclEntry",
  660. "label": "ACL Entry",
  661. "schema": {
  662. "type": "dict",
  663. "attrs": [
  664. {
  665. "variable": "id_type",
  666. "label": "ID Type",
  667. "schema": {
  668. "type": "string",
  669. "enum": [
  670. {
  671. "value": "USER",
  672. "description": "Entry is for a USER"
  673. },
  674. {
  675. "value": "GROUP",
  676. "description": "Entry is for a GROUP"
  677. }
  678. ],
  679. "default": "USER"
  680. }
  681. },
  682. {
  683. "variable": "id",
  684. "label": "ID",
  685. "description": "Make sure to check the ID value is correct and aligns with RunAs user context of the application",
  686. "schema": {
  687. "type": "int",
  688. "required": true,
  689. "min": 0
  690. }
  691. },
  692. {
  693. "variable": "access",
  694. "label": "Access",
  695. "schema": {
  696. "type": "string",
  697. "enum": [
  698. {
  699. "value": "READ",
  700. "description": "Read Access"
  701. },
  702. {
  703. "value": "MODIFY",
  704. "description": "Modify Access"
  705. },
  706. {
  707. "value": "FULL_CONTROL",
  708. "description": "FULL_CONTROL Access"
  709. }
  710. ]
  711. }
  712. }
  713. ]
  714. }
  715. }
  716. ]
  717. }
  718. }
  719. ]
  720. }
  721. }
  722. ]
  723. }
  724. },
  725. {
  726. "variable": "hostPathConfig",
  727. "label": "Host Path Configuration",
  728. "schema": {
  729. "type": "dict",
  730. "show_if": [
  731. [
  732. "type",
  733. "=",
  734. "hostPath"
  735. ]
  736. ],
  737. "attrs": [
  738. {
  739. "variable": "aclEnable",
  740. "label": "Enable ACL",
  741. "description": "Enable ACL for the dataset.",
  742. "schema": {
  743. "type": "boolean",
  744. "default": false
  745. }
  746. },
  747. {
  748. "variable": "acl",
  749. "label": "ACL Configuration",
  750. "schema": {
  751. "type": "dict",
  752. "show_if": [
  753. [
  754. "aclEnable",
  755. "=",
  756. true
  757. ]
  758. ],
  759. "attrs": [
  760. {
  761. "variable": "path",
  762. "label": "Host Path",
  763. "description": "Host Path to perform ACL",
  764. "schema": {
  765. "type": "hostpath",
  766. "required": true,
  767. "empty": false
  768. }
  769. },
  770. {
  771. "variable": "entries",
  772. "label": "ACL Entries",
  773. "description": "ACL Entries",
  774. "schema": {
  775. "type": "list",
  776. "items": [
  777. {
  778. "variable": "aclEntry",
  779. "label": "ACL Entry",
  780. "schema": {
  781. "type": "dict",
  782. "attrs": [
  783. {
  784. "variable": "id_type",
  785. "label": "ID Type",
  786. "schema": {
  787. "type": "string",
  788. "enum": [
  789. {
  790. "value": "USER",
  791. "description": "Entry is for a USER"
  792. },
  793. {
  794. "value": "GROUP",
  795. "description": "Entry is for a GROUP"
  796. }
  797. ],
  798. "default": "USER"
  799. }
  800. },
  801. {
  802. "variable": "id",
  803. "label": "ID",
  804. "description": "Make sure to check the ID value is correct and aligns with RunAs user context of the application",
  805. "schema": {
  806. "type": "int",
  807. "required": true,
  808. "min": 0
  809. }
  810. },
  811. {
  812. "variable": "access",
  813. "label": "Access",
  814. "schema": {
  815. "type": "string",
  816. "enum": [
  817. {
  818. "value": "READ",
  819. "description": "Read Access"
  820. },
  821. {
  822. "value": "MODIFY",
  823. "description": "Modify Access"
  824. },
  825. {
  826. "value": "FULL_CONTROL",
  827. "description": "FULL_CONTROL Access"
  828. }
  829. ]
  830. }
  831. }
  832. ]
  833. }
  834. }
  835. ]
  836. }
  837. },
  838. {
  839. "variable": "options",
  840. "label": "ACL Options",
  841. "schema": {
  842. "type": "dict",
  843. "attrs": [
  844. {
  845. "variable": "force",
  846. "label": "Force Flag",
  847. "description": "Enabling `Force` applies ACL even if the path has existing data",
  848. "schema": {
  849. "type": "boolean",
  850. "default": false
  851. }
  852. }
  853. ]
  854. }
  855. }
  856. ],
  857. "$ref": [
  858. "normalize/acl"
  859. ]
  860. }
  861. },
  862. {
  863. "variable": "hostPath",
  864. "label": "Host Path",
  865. "description": "The host path to use for storage.",
  866. "schema": {
  867. "type": "hostpath",
  868. "show_if": [
  869. [
  870. "aclEnable",
  871. "=",
  872. false
  873. ]
  874. ],
  875. "required": true
  876. }
  877. }
  878. ]
  879. }
  880. }
  881. ]
  882. }
  883. },
  884. {
  885. "variable": "additionalStorages",
  886. "label": "Additional Storage",
  887. "description": "Additional storage for Audiobookshelf.",
  888. "schema": {
  889. "type": "list",
  890. "default": [],
  891. "items": [
  892. {
  893. "variable": "storageEntry",
  894. "label": "Storage Entry",
  895. "schema": {
  896. "type": "dict",
  897. "attrs": [
  898. {
  899. "variable": "type",
  900. "label": "Type",
  901. "description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.</br>\nSMB Share: Is a SMB share that is mounted to a persistent volume claim.\n",
  902. "schema": {
  903. "type": "string",
  904. "required": true,
  905. "default": "ixVolume",
  906. "immutable": true,
  907. "enum": [
  908. {
  909. "value": "hostPath",
  910. "description": "Host Path (Path that already exists on the system)"
  911. },
  912. {
  913. "value": "ixVolume",
  914. "description": "ixVolume (Dataset created automatically by the system)"
  915. },
  916. {
  917. "value": "smb-pv-pvc",
  918. "description": "SMB Share (Mounts a persistent volume claim to a SMB share)"
  919. }
  920. ]
  921. }
  922. },
  923. {
  924. "variable": "readOnly",
  925. "label": "Read Only",
  926. "description": "Mount the volume as read only.",
  927. "schema": {
  928. "type": "boolean",
  929. "default": false
  930. }
  931. },
  932. {
  933. "variable": "mountPath",
  934. "label": "Mount Path",
  935. "description": "The path inside the container to mount the storage.",
  936. "schema": {
  937. "type": "path",
  938. "required": true
  939. }
  940. },
  941. {
  942. "variable": "hostPathConfig",
  943. "label": "Host Path Configuration",
  944. "schema": {
  945. "type": "dict",
  946. "show_if": [
  947. [
  948. "type",
  949. "=",
  950. "hostPath"
  951. ]
  952. ],
  953. "attrs": [
  954. {
  955. "variable": "aclEnable",
  956. "label": "Enable ACL",
  957. "description": "Enable ACL for the dataset.",
  958. "schema": {
  959. "type": "boolean",
  960. "default": false
  961. }
  962. },
  963. {
  964. "variable": "acl",
  965. "label": "ACL Configuration",
  966. "schema": {
  967. "type": "dict",
  968. "show_if": [
  969. [
  970. "aclEnable",
  971. "=",
  972. true
  973. ]
  974. ],
  975. "attrs": [
  976. {
  977. "variable": "path",
  978. "label": "Host Path",
  979. "description": "Host Path to perform ACL",
  980. "schema": {
  981. "type": "hostpath",
  982. "required": true,
  983. "empty": false
  984. }
  985. },
  986. {
  987. "variable": "entries",
  988. "label": "ACL Entries",
  989. "description": "ACL Entries",
  990. "schema": {
  991. "type": "list",
  992. "items": [
  993. {
  994. "variable": "aclEntry",
  995. "label": "ACL Entry",
  996. "schema": {
  997. "type": "dict",
  998. "attrs": [
  999. {
  1000. "variable": "id_type",
  1001. "label": "ID Type",
  1002. "schema": {
  1003. "type": "string",
  1004. "enum": [
  1005. {
  1006. "value": "USER",
  1007. "description": "Entry is for a USER"
  1008. },
  1009. {
  1010. "value": "GROUP",
  1011. "description": "Entry is for a GROUP"
  1012. }
  1013. ],
  1014. "default": "USER"
  1015. }
  1016. },
  1017. {
  1018. "variable": "id",
  1019. "label": "ID",
  1020. "description": "Make sure to check the ID value is correct and aligns with RunAs user context of the application",
  1021. "schema": {
  1022. "type": "int",
  1023. "required": true,
  1024. "min": 0
  1025. }
  1026. },
  1027. {
  1028. "variable": "access",
  1029. "label": "Access",
  1030. "schema": {
  1031. "type": "string",
  1032. "enum": [
  1033. {
  1034. "value": "READ",
  1035. "description": "Read Access"
  1036. },
  1037. {
  1038. "value": "MODIFY",
  1039. "description": "Modify Access"
  1040. },
  1041. {
  1042. "value": "FULL_CONTROL",
  1043. "description": "FULL_CONTROL Access"
  1044. }
  1045. ]
  1046. }
  1047. }
  1048. ]
  1049. }
  1050. }
  1051. ]
  1052. }
  1053. },
  1054. {
  1055. "variable": "options",
  1056. "label": "ACL Options",
  1057. "schema": {
  1058. "type": "dict",
  1059. "attrs": [
  1060. {
  1061. "variable": "force",
  1062. "label": "Force Flag",
  1063. "description": "Enabling `Force` applies ACL even if the path has existing data",
  1064. "schema": {
  1065. "type": "boolean",
  1066. "default": false
  1067. }
  1068. }
  1069. ]
  1070. }
  1071. }
  1072. ],
  1073. "$ref": [
  1074. "normalize/acl"
  1075. ]
  1076. }
  1077. },
  1078. {
  1079. "variable": "hostPath",
  1080. "label": "Host Path",
  1081. "description": "The host path to use for storage.",
  1082. "schema": {
  1083. "type": "hostpath",
  1084. "show_if": [
  1085. [
  1086. "aclEnable",
  1087. "=",
  1088. false
  1089. ]
  1090. ],
  1091. "required": true
  1092. }
  1093. }
  1094. ]
  1095. }
  1096. },
  1097. {
  1098. "variable": "ixVolumeConfig",
  1099. "label": "ixVolume Configuration",
  1100. "description": "The configuration for the ixVolume dataset.",
  1101. "schema": {
  1102. "type": "dict",
  1103. "show_if": [
  1104. [
  1105. "type",
  1106. "=",
  1107. "ixVolume"
  1108. ]
  1109. ],
  1110. "$ref": [
  1111. "normalize/ixVolume"
  1112. ],
  1113. "attrs": [
  1114. {
  1115. "variable": "aclEnable",
  1116. "label": "Enable ACL",
  1117. "description": "Enable ACL for the dataset.",
  1118. "schema": {
  1119. "type": "boolean",
  1120. "default": false
  1121. }
  1122. },
  1123. {
  1124. "variable": "datasetName",
  1125. "label": "Dataset Name",
  1126. "description": "The name of the dataset to use for storage.",
  1127. "schema": {
  1128. "type": "string",
  1129. "required": true,
  1130. "immutable": true,
  1131. "default": "storage_entry"
  1132. }
  1133. },
  1134. {
  1135. "variable": "aclEntries",
  1136. "label": "ACL Configuration",
  1137. "schema": {
  1138. "type": "dict",
  1139. "show_if": [
  1140. [
  1141. "aclEnable",
  1142. "=",
  1143. true
  1144. ]
  1145. ],
  1146. "attrs": [
  1147. {
  1148. "variable": "path",
  1149. "label": "Path",
  1150. "description": "Path to perform ACL",
  1151. "schema": {
  1152. "type": "string",
  1153. "hidden": true
  1154. }
  1155. },
  1156. {
  1157. "variable": "entries",
  1158. "label": "ACL Entries",
  1159. "description": "ACL Entries",
  1160. "schema": {
  1161. "type": "list",
  1162. "items": [
  1163. {
  1164. "variable": "aclEntry",
  1165. "label": "ACL Entry",
  1166. "schema": {
  1167. "type": "dict",
  1168. "attrs": [
  1169. {
  1170. "variable": "id_type",
  1171. "label": "ID Type",
  1172. "schema": {
  1173. "type": "string",
  1174. "enum": [
  1175. {
  1176. "value": "USER",
  1177. "description": "Entry is for a USER"
  1178. },
  1179. {
  1180. "value": "GROUP",
  1181. "description": "Entry is for a GROUP"
  1182. }
  1183. ],
  1184. "default": "USER"
  1185. }
  1186. },
  1187. {
  1188. "variable": "id",
  1189. "label": "ID",
  1190. "description": "Make sure to check the ID value is correct and aligns with RunAs user context of the application",
  1191. "schema": {
  1192. "type": "int",
  1193. "required": true,
  1194. "min": 0
  1195. }
  1196. },
  1197. {
  1198. "variable": "access",
  1199. "label": "Access",
  1200. "schema": {
  1201. "type": "string",
  1202. "enum": [
  1203. {
  1204. "value": "READ",
  1205. "description": "Read Access"
  1206. },
  1207. {
  1208. "value": "MODIFY",
  1209. "description": "Modify Access"
  1210. },
  1211. {
  1212. "value": "FULL_CONTROL",
  1213. "description": "FULL_CONTROL Access"
  1214. }
  1215. ]
  1216. }
  1217. }
  1218. ]
  1219. }
  1220. }
  1221. ]
  1222. }
  1223. }
  1224. ]
  1225. }
  1226. }
  1227. ]
  1228. }
  1229. },
  1230. {
  1231. "variable": "smbConfig",
  1232. "label": "SMB Share Configuration",
  1233. "description": "The configuration for the SMB Share.",
  1234. "schema": {
  1235. "type": "dict",
  1236. "show_if": [
  1237. [
  1238. "type",
  1239. "=",
  1240. "smb-pv-pvc"
  1241. ]
  1242. ],
  1243. "attrs": [
  1244. {
  1245. "variable": "server",
  1246. "label": "Server",
  1247. "description": "The server for the SMB share.",
  1248. "schema": {
  1249. "type": "string",
  1250. "required": true
  1251. }
  1252. },
  1253. {
  1254. "variable": "share",
  1255. "label": "Share",
  1256. "description": "The share name for the SMB share.",
  1257. "schema": {
  1258. "type": "string",
  1259. "required": true
  1260. }
  1261. },
  1262. {
  1263. "variable": "domain",
  1264. "label": "Domain (Optional)",
  1265. "description": "The domain for the SMB share.",
  1266. "schema": {
  1267. "type": "string"
  1268. }
  1269. },
  1270. {
  1271. "variable": "username",
  1272. "label": "Username",
  1273. "description": "The username for the SMB share.",
  1274. "schema": {
  1275. "type": "string",
  1276. "required": true
  1277. }
  1278. },
  1279. {
  1280. "variable": "password",
  1281. "label": "Password",
  1282. "description": "The password for the SMB share.",
  1283. "schema": {
  1284. "type": "string",
  1285. "required": true,
  1286. "private": true
  1287. }
  1288. },
  1289. {
  1290. "variable": "size",
  1291. "label": "Size (in Gi)",
  1292. "description": "The size of the volume quota.",
  1293. "schema": {
  1294. "type": "int",
  1295. "required": true,
  1296. "min": 1,
  1297. "default": 1
  1298. }
  1299. }
  1300. ]
  1301. }
  1302. }
  1303. ]
  1304. }
  1305. }
  1306. ]
  1307. }
  1308. }
  1309. ]
  1310. }
  1311. },
  1312. {
  1313. "variable": "resources",
  1314. "group": "Resources Configuration",
  1315. "label": "",
  1316. "schema": {
  1317. "type": "dict",
  1318. "attrs": [
  1319. {
  1320. "variable": "limits",
  1321. "label": "Limits",
  1322. "schema": {
  1323. "type": "dict",
  1324. "attrs": [
  1325. {
  1326. "variable": "cpu",
  1327. "label": "CPU",
  1328. "description": "CPU limit for Audiobookshelf.",
  1329. "schema": {
  1330. "type": "string",
  1331. "max_length": 6,
  1332. "valid_chars": "^(0\\.[1-9]|[1-9][0-9]*)(\\.[0-9]|m?)$",
  1333. "valid_chars_error": "Valid CPU limit formats are</br>\n- Plain Integer - eg. 1</br>\n- Float - eg. 0.5</br>\n- Milicpu - eg. 500m\n",
  1334. "default": "4000m",
  1335. "required": true
  1336. }
  1337. },
  1338. {
  1339. "variable": "memory",
  1340. "label": "Memory",
  1341. "description": "Memory limit for Audiobookshelf.",
  1342. "schema": {
  1343. "type": "string",
  1344. "max_length": 12,
  1345. "valid_chars": "^[1-9][0-9]*([EPTGMK]i?|e[0-9]+)?$",
  1346. "valid_chars_error": "Valid Memory limit formats are</br>\n- Suffixed with E/P/T/G/M/K - eg. 1G</br>\n- Suffixed with Ei/Pi/Ti/Gi/Mi/Ki - eg. 1Gi</br>\n- Plain Integer in bytes - eg. 1024</br>\n- Exponent - eg. 134e6\n",
  1347. "default": "8Gi",
  1348. "required": true
  1349. }
  1350. }
  1351. ]
  1352. }
  1353. }
  1354. ]
  1355. }
  1356. }
  1357. ]
  1358. },
  1359. "app_readme": "<h1>Audiobookshelf</h1>\n<p><a href=\"https://www.audiobookshelf.org/\">Audiobookshelf</a> is a self-hosted audiobook and podcast server.</p>\n<blockquote>\n<p>The following applies only when the storage type is set to <strong>ixVolume</strong>\nWhen application is installed, a container will be launched with <strong>root</strong> privileges.\nThis is required in order to apply the correct permissions to the <code>Audiobookshelf</code> directories.\nAfterward, the <code>Audiobookshelf</code> container will run as a <strong>non</strong>-root user (Default: <code>568</code>).\nAll mounted storage(s) will be <code>chown</code>ed only if the parent directory does not match the configured user.</p>\n</blockquote>",
  1360. "detailed_readme": "<h1>Audiobookshelf</h1>\n<p><a href=\"https://www.audiobookshelf.org/\">Audiobookshelf</a> is a self-hosted audiobook and podcast server.</p>\n<blockquote>\n<p>The following applies only when the storage type is set to <strong>ixVolume</strong>\nWhen application is installed, a container will be launched with <strong>root</strong> privileges.\nThis is required in order to apply the correct permissions to the <code>Audiobookshelf</code> directories.\nAfterward, the <code>Audiobookshelf</code> container will run as a <strong>non</strong>-root user (Default: <code>568</code>).\nAll mounted storage(s) will be <code>chown</code>ed only if the parent directory does not match the configured user.</p>\n</blockquote>",
  1361. "changelog": null
  1362. }
  1363. }