app_versions.json 121 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580
  1. {
  2. "1.2.0": {
  3. "healthy": true,
  4. "supported": false,
  5. "healthy_error": null,
  6. "location": "/__w/charts/charts/community/briefkasten/1.2.0",
  7. "last_update": "2023-12-13 17:07:45",
  8. "required_features": [
  9. "normalize/ixVolume",
  10. "normalize/acl"
  11. ],
  12. "human_version": "latest_1.2.0",
  13. "version": "1.2.0",
  14. "chart_metadata": {
  15. "name": "briefkasten",
  16. "description": "Briefkasten is a self hosted bookmarking app",
  17. "annotations": {
  18. "title": "Briefkasten"
  19. },
  20. "type": "application",
  21. "version": "1.2.0",
  22. "apiVersion": "v2",
  23. "appVersion": "latest",
  24. "kubeVersion": ">=1.16.0-0",
  25. "maintainers": [
  26. {
  27. "name": "truenas",
  28. "url": "https://www.truenas.com/",
  29. "email": "dev@ixsystems.com"
  30. }
  31. ],
  32. "dependencies": [
  33. {
  34. "name": "common",
  35. "repository": "file://../../../common",
  36. "version": "1.2.4"
  37. }
  38. ],
  39. "home": "https://github.com/ndom91/briefkasten",
  40. "icon": "https://media.sys.truenas.net/apps/briefkasten/icons/icon.svg",
  41. "sources": [
  42. "https://github.com/truenas/charts/tree/master/library/ix-dev/community/briefkasten",
  43. "https://github.com/ndom91/briefkasten",
  44. "https://docs.briefkastenhq.com/"
  45. ],
  46. "keywords": [
  47. "bookmark"
  48. ]
  49. },
  50. "app_metadata": {
  51. "runAsContext": [
  52. {
  53. "userName": "briefkasten",
  54. "groupName": "briefkasten",
  55. "gid": 1001,
  56. "uid": 1001,
  57. "description": "Briefkasten can runs as a non-root user."
  58. },
  59. {
  60. "userName": "postgres",
  61. "groupName": "postgres",
  62. "gid": 999,
  63. "uid": 999,
  64. "description": "Postgres runs as a non-root user."
  65. }
  66. ],
  67. "capabilities": [],
  68. "hostMounts": []
  69. },
  70. "schema": {
  71. "groups": [
  72. {
  73. "name": "Briefkasten Configuration",
  74. "description": "Configure Briefkasten"
  75. },
  76. {
  77. "name": "Network Configuration",
  78. "description": "Configure Network for Briefkasten"
  79. },
  80. {
  81. "name": "Storage Configuration",
  82. "description": "Configure Storage for Briefkasten"
  83. },
  84. {
  85. "name": "Resources Configuration",
  86. "description": "Configure Resources for Briefkasten"
  87. }
  88. ],
  89. "portals": {
  90. "web_portal": {
  91. "protocols": [
  92. "$kubernetes-resource_configmap_portal_protocol"
  93. ],
  94. "host": [
  95. "$kubernetes-resource_configmap_portal_host"
  96. ],
  97. "ports": [
  98. "$kubernetes-resource_configmap_portal_port"
  99. ],
  100. "path": "$kubernetes-resource_configmap_portal_path"
  101. }
  102. },
  103. "questions": [
  104. {
  105. "variable": "briefkastenConfig",
  106. "label": "",
  107. "group": "Briefkasten Configuration",
  108. "schema": {
  109. "type": "dict",
  110. "attrs": [
  111. {
  112. "variable": "url",
  113. "label": "BaseURL",
  114. "description": "The URL that Briefkasten will be accessible from.</br>\nExample: </br>\nhttp://server.ip:30080</br>\nhttps://Briefkasten.example.com\n",
  115. "schema": {
  116. "type": "uri",
  117. "default": "",
  118. "required": true
  119. }
  120. },
  121. {
  122. "variable": "smtp",
  123. "label": "SMTP Auth Provider",
  124. "description": "Configure SMTP for Briefkasten.",
  125. "schema": {
  126. "type": "dict",
  127. "attrs": [
  128. {
  129. "variable": "enabled",
  130. "label": "Enabled",
  131. "description": "Enable SMTP for auth.",
  132. "schema": {
  133. "type": "boolean",
  134. "default": false,
  135. "show_subquestions_if": true,
  136. "subquestions": [
  137. {
  138. "variable": "server",
  139. "label": "SMTP Server",
  140. "description": "The SMTP server to use.",
  141. "schema": {
  142. "type": "string",
  143. "default": "",
  144. "required": true
  145. }
  146. },
  147. {
  148. "variable": "from",
  149. "label": "SMTP From",
  150. "description": "The SMTP from address to use.",
  151. "schema": {
  152. "type": "string",
  153. "default": "",
  154. "required": true
  155. }
  156. }
  157. ]
  158. }
  159. }
  160. ]
  161. }
  162. },
  163. {
  164. "variable": "github",
  165. "label": "GitHub Auth Provider",
  166. "description": "Configure GitHub for Briefkasten.",
  167. "schema": {
  168. "type": "dict",
  169. "attrs": [
  170. {
  171. "variable": "enabled",
  172. "label": "Enabled",
  173. "description": "Enable GitHub for auth.",
  174. "schema": {
  175. "type": "boolean",
  176. "default": false,
  177. "show_subquestions_if": true,
  178. "subquestions": [
  179. {
  180. "variable": "id",
  181. "label": "GitHub Client ID",
  182. "description": "The GitHub Client ID.",
  183. "schema": {
  184. "type": "string",
  185. "default": "",
  186. "required": true
  187. }
  188. },
  189. {
  190. "variable": "secret",
  191. "label": "GitHub Client Secret",
  192. "description": "The GitHub Client Secret.",
  193. "schema": {
  194. "type": "string",
  195. "default": "",
  196. "private": true,
  197. "required": true
  198. }
  199. }
  200. ]
  201. }
  202. }
  203. ]
  204. }
  205. },
  206. {
  207. "variable": "google",
  208. "label": "Google Auth Provider",
  209. "description": "Configure Google for Briefkasten.",
  210. "schema": {
  211. "type": "dict",
  212. "attrs": [
  213. {
  214. "variable": "enabled",
  215. "label": "Enabled",
  216. "description": "Enable Google for auth.",
  217. "schema": {
  218. "type": "boolean",
  219. "default": false,
  220. "show_subquestions_if": true,
  221. "subquestions": [
  222. {
  223. "variable": "id",
  224. "label": "Google Client ID",
  225. "description": "The Google Client ID.",
  226. "schema": {
  227. "type": "string",
  228. "default": "",
  229. "required": true
  230. }
  231. },
  232. {
  233. "variable": "secret",
  234. "label": "Google Client Secret",
  235. "description": "The Google Client Secret.",
  236. "schema": {
  237. "type": "string",
  238. "default": "",
  239. "private": true,
  240. "required": true
  241. }
  242. }
  243. ]
  244. }
  245. }
  246. ]
  247. }
  248. },
  249. {
  250. "variable": "keycloak",
  251. "label": "Keycloak Auth Provider",
  252. "description": "Configure Keycloak for Briefkasten.",
  253. "schema": {
  254. "type": "dict",
  255. "attrs": [
  256. {
  257. "variable": "enabled",
  258. "label": "Enabled",
  259. "description": "Enable Keycloak for auth.",
  260. "schema": {
  261. "type": "boolean",
  262. "default": false,
  263. "show_subquestions_if": true,
  264. "subquestions": [
  265. {
  266. "variable": "name",
  267. "label": "Keycloak Name",
  268. "description": "The Keycloak Name.",
  269. "schema": {
  270. "type": "string",
  271. "default": "",
  272. "required": true
  273. }
  274. },
  275. {
  276. "variable": "id",
  277. "label": "Keycloak Client ID",
  278. "description": "The Keycloak Client ID.",
  279. "schema": {
  280. "type": "string",
  281. "default": "",
  282. "required": true
  283. }
  284. },
  285. {
  286. "variable": "secret",
  287. "label": "Keycloak Client Secret",
  288. "description": "The Keycloak Client Secret.",
  289. "schema": {
  290. "type": "string",
  291. "default": "",
  292. "private": true,
  293. "required": true
  294. }
  295. },
  296. {
  297. "variable": "issuer",
  298. "label": "Keycloak Issuer",
  299. "description": "The Keycloak Issuer.",
  300. "schema": {
  301. "type": "string",
  302. "default": "",
  303. "required": true
  304. }
  305. }
  306. ]
  307. }
  308. }
  309. ]
  310. }
  311. },
  312. {
  313. "variable": "authentik",
  314. "label": "Authentik Auth Provider",
  315. "description": "Configure Authentik for Briefkasten.",
  316. "schema": {
  317. "type": "dict",
  318. "attrs": [
  319. {
  320. "variable": "enabled",
  321. "label": "Enabled",
  322. "description": "Enable Authentik for auth.",
  323. "schema": {
  324. "type": "boolean",
  325. "default": false,
  326. "show_subquestions_if": true,
  327. "subquestions": [
  328. {
  329. "variable": "name",
  330. "label": "Authentik Name",
  331. "description": "The Authentik Name.",
  332. "schema": {
  333. "type": "string",
  334. "default": "",
  335. "required": true
  336. }
  337. },
  338. {
  339. "variable": "id",
  340. "label": "Authentik Client ID",
  341. "description": "The Authentik Client ID.",
  342. "schema": {
  343. "type": "string",
  344. "default": "",
  345. "required": true
  346. }
  347. },
  348. {
  349. "variable": "secret",
  350. "label": "Authentik Client Secret",
  351. "description": "The Authentik Client Secret.",
  352. "schema": {
  353. "type": "string",
  354. "default": "",
  355. "private": true,
  356. "required": true
  357. }
  358. },
  359. {
  360. "variable": "issuer",
  361. "label": "Authentik Issuer",
  362. "description": "The Authentik Issuer.",
  363. "schema": {
  364. "type": "string",
  365. "default": "",
  366. "required": true
  367. }
  368. }
  369. ]
  370. }
  371. }
  372. ]
  373. }
  374. },
  375. {
  376. "variable": "additionalEnvs",
  377. "label": "Additional Environment Variables",
  378. "description": "Configure additional environment variables for Briefkasten.",
  379. "schema": {
  380. "type": "list",
  381. "default": [],
  382. "items": [
  383. {
  384. "variable": "env",
  385. "label": "Environment Variable",
  386. "schema": {
  387. "type": "dict",
  388. "attrs": [
  389. {
  390. "variable": "name",
  391. "label": "Name",
  392. "schema": {
  393. "type": "string",
  394. "required": true
  395. }
  396. },
  397. {
  398. "variable": "value",
  399. "label": "Value",
  400. "schema": {
  401. "type": "string",
  402. "required": true
  403. }
  404. }
  405. ]
  406. }
  407. }
  408. ]
  409. }
  410. }
  411. ]
  412. }
  413. },
  414. {
  415. "variable": "briefkastenNetwork",
  416. "label": "",
  417. "group": "Network Configuration",
  418. "schema": {
  419. "type": "dict",
  420. "attrs": [
  421. {
  422. "variable": "webPort",
  423. "label": "Web Port",
  424. "description": "The port for the Briefkasten Web UI.",
  425. "schema": {
  426. "type": "int",
  427. "default": 30080,
  428. "min": 9000,
  429. "max": 65535,
  430. "required": true
  431. }
  432. },
  433. {
  434. "variable": "hostNetwork",
  435. "label": "Host Network",
  436. "description": "Bind to the host network. It's recommended to keep this disabled.</br>\n",
  437. "schema": {
  438. "type": "boolean",
  439. "default": false
  440. }
  441. }
  442. ]
  443. }
  444. },
  445. {
  446. "variable": "briefkastenStorage",
  447. "label": "",
  448. "group": "Storage Configuration",
  449. "schema": {
  450. "type": "dict",
  451. "attrs": [
  452. {
  453. "variable": "pgData",
  454. "label": "Postgres Data Storage",
  455. "description": "The path to store Postgres Data.",
  456. "schema": {
  457. "type": "dict",
  458. "attrs": [
  459. {
  460. "variable": "type",
  461. "label": "Type",
  462. "description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.\n",
  463. "schema": {
  464. "type": "string",
  465. "required": true,
  466. "immutable": true,
  467. "default": "ixVolume",
  468. "enum": [
  469. {
  470. "value": "hostPath",
  471. "description": "Host Path (Path that already exists on the system)"
  472. },
  473. {
  474. "value": "ixVolume",
  475. "description": "ixVolume (Dataset created automatically by the system)"
  476. }
  477. ]
  478. }
  479. },
  480. {
  481. "variable": "ixVolumeConfig",
  482. "label": "ixVolume Configuration",
  483. "description": "The configuration for the ixVolume dataset.",
  484. "schema": {
  485. "type": "dict",
  486. "hidden": true,
  487. "show_if": [
  488. [
  489. "type",
  490. "=",
  491. "ixVolume"
  492. ]
  493. ],
  494. "$ref": [
  495. "normalize/ixVolume"
  496. ],
  497. "attrs": [
  498. {
  499. "variable": "aclEnable",
  500. "label": "Enable ACL",
  501. "description": "Enable ACL for the dataset.",
  502. "schema": {
  503. "type": "boolean",
  504. "hidden": true,
  505. "default": false
  506. }
  507. },
  508. {
  509. "variable": "datasetName",
  510. "label": "Dataset Name",
  511. "description": "The name of the dataset to use for storage.",
  512. "schema": {
  513. "type": "string",
  514. "required": true,
  515. "immutable": true,
  516. "hidden": true,
  517. "default": "pgData"
  518. }
  519. },
  520. {
  521. "variable": "aclEntries",
  522. "label": "ACL Configuration",
  523. "schema": {
  524. "type": "dict",
  525. "show_if": [
  526. [
  527. "aclEnable",
  528. "=",
  529. true
  530. ]
  531. ],
  532. "attrs": [
  533. {
  534. "variable": "path",
  535. "label": "Path",
  536. "description": "Path to perform ACL",
  537. "schema": {
  538. "type": "string",
  539. "hidden": true
  540. }
  541. },
  542. {
  543. "variable": "entries",
  544. "label": "ACL Entries",
  545. "description": "ACL Entries",
  546. "schema": {
  547. "type": "list",
  548. "items": [
  549. {
  550. "variable": "aclEntry",
  551. "label": "ACL Entry",
  552. "schema": {
  553. "type": "dict",
  554. "attrs": [
  555. {
  556. "variable": "id_type",
  557. "label": "ID Type",
  558. "schema": {
  559. "type": "string",
  560. "enum": [
  561. {
  562. "value": "USER",
  563. "description": "Entry is for a USER"
  564. },
  565. {
  566. "value": "GROUP",
  567. "description": "Entry is for a GROUP"
  568. }
  569. ],
  570. "default": "USER"
  571. }
  572. },
  573. {
  574. "variable": "id",
  575. "label": "ID",
  576. "description": "Make sure to check the ID value is correct and aligns with RunAs user context of the application",
  577. "schema": {
  578. "type": "int",
  579. "required": true,
  580. "min": 0
  581. }
  582. },
  583. {
  584. "variable": "access",
  585. "label": "Access",
  586. "schema": {
  587. "type": "string",
  588. "enum": [
  589. {
  590. "value": "READ",
  591. "description": "Read Access"
  592. },
  593. {
  594. "value": "MODIFY",
  595. "description": "Modify Access"
  596. },
  597. {
  598. "value": "FULL_CONTROL",
  599. "description": "FULL_CONTROL Access"
  600. }
  601. ]
  602. }
  603. }
  604. ]
  605. }
  606. }
  607. ]
  608. }
  609. }
  610. ]
  611. }
  612. }
  613. ]
  614. }
  615. },
  616. {
  617. "variable": "hostPathConfig",
  618. "label": "Host Path Configuration",
  619. "schema": {
  620. "type": "dict",
  621. "show_if": [
  622. [
  623. "type",
  624. "=",
  625. "hostPath"
  626. ]
  627. ],
  628. "attrs": [
  629. {
  630. "variable": "aclEnable",
  631. "label": "Enable ACL",
  632. "description": "Enable ACL for the dataset.",
  633. "schema": {
  634. "type": "boolean",
  635. "hidden": true,
  636. "default": false
  637. }
  638. },
  639. {
  640. "variable": "acl",
  641. "label": "ACL Configuration",
  642. "schema": {
  643. "type": "dict",
  644. "show_if": [
  645. [
  646. "aclEnable",
  647. "=",
  648. true
  649. ]
  650. ],
  651. "attrs": [
  652. {
  653. "variable": "path",
  654. "label": "Host Path",
  655. "description": "Host Path to perform ACL",
  656. "schema": {
  657. "type": "hostpath",
  658. "required": true,
  659. "empty": false
  660. }
  661. },
  662. {
  663. "variable": "entries",
  664. "label": "ACL Entries",
  665. "description": "ACL Entries",
  666. "schema": {
  667. "type": "list",
  668. "items": [
  669. {
  670. "variable": "aclEntry",
  671. "label": "ACL Entry",
  672. "schema": {
  673. "type": "dict",
  674. "attrs": [
  675. {
  676. "variable": "id_type",
  677. "label": "ID Type",
  678. "schema": {
  679. "type": "string",
  680. "enum": [
  681. {
  682. "value": "USER",
  683. "description": "Entry is for a USER"
  684. },
  685. {
  686. "value": "GROUP",
  687. "description": "Entry is for a GROUP"
  688. }
  689. ],
  690. "default": "USER"
  691. }
  692. },
  693. {
  694. "variable": "id",
  695. "label": "ID",
  696. "description": "Make sure to check the ID value is correct and aligns with RunAs user context of the application",
  697. "schema": {
  698. "type": "int",
  699. "required": true,
  700. "min": 0
  701. }
  702. },
  703. {
  704. "variable": "access",
  705. "label": "Access",
  706. "schema": {
  707. "type": "string",
  708. "enum": [
  709. {
  710. "value": "READ",
  711. "description": "Read Access"
  712. },
  713. {
  714. "value": "MODIFY",
  715. "description": "Modify Access"
  716. },
  717. {
  718. "value": "FULL_CONTROL",
  719. "description": "FULL_CONTROL Access"
  720. }
  721. ]
  722. }
  723. }
  724. ]
  725. }
  726. }
  727. ]
  728. }
  729. },
  730. {
  731. "variable": "options",
  732. "label": "ACL Options",
  733. "schema": {
  734. "type": "dict",
  735. "attrs": [
  736. {
  737. "variable": "force",
  738. "label": "Force Flag",
  739. "description": "Enabling `Force` applies ACL even if the path has existing data",
  740. "schema": {
  741. "type": "boolean",
  742. "default": false
  743. }
  744. }
  745. ]
  746. }
  747. }
  748. ],
  749. "$ref": [
  750. "normalize/acl"
  751. ]
  752. }
  753. },
  754. {
  755. "variable": "hostPath",
  756. "label": "Host Path",
  757. "description": "The host path to use for storage.",
  758. "schema": {
  759. "type": "hostpath",
  760. "show_if": [
  761. [
  762. "aclEnable",
  763. "=",
  764. false
  765. ]
  766. ],
  767. "required": true
  768. }
  769. }
  770. ]
  771. }
  772. }
  773. ]
  774. }
  775. },
  776. {
  777. "variable": "pgBackup",
  778. "label": "Postgres Backup Storage",
  779. "description": "The path to store Postgres Backup.",
  780. "schema": {
  781. "type": "dict",
  782. "attrs": [
  783. {
  784. "variable": "type",
  785. "label": "Type",
  786. "description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.\n",
  787. "schema": {
  788. "type": "string",
  789. "required": true,
  790. "immutable": true,
  791. "default": "ixVolume",
  792. "enum": [
  793. {
  794. "value": "hostPath",
  795. "description": "Host Path (Path that already exists on the system)"
  796. },
  797. {
  798. "value": "ixVolume",
  799. "description": "ixVolume (Dataset created automatically by the system)"
  800. }
  801. ]
  802. }
  803. },
  804. {
  805. "variable": "ixVolumeConfig",
  806. "label": "ixVolume Configuration",
  807. "description": "The configuration for the ixVolume dataset.",
  808. "schema": {
  809. "type": "dict",
  810. "hidden": true,
  811. "show_if": [
  812. [
  813. "type",
  814. "=",
  815. "ixVolume"
  816. ]
  817. ],
  818. "$ref": [
  819. "normalize/ixVolume"
  820. ],
  821. "attrs": [
  822. {
  823. "variable": "aclEnable",
  824. "label": "Enable ACL",
  825. "description": "Enable ACL for the dataset.",
  826. "schema": {
  827. "type": "boolean",
  828. "hidden": true,
  829. "default": false
  830. }
  831. },
  832. {
  833. "variable": "datasetName",
  834. "label": "Dataset Name",
  835. "description": "The name of the dataset to use for storage.",
  836. "schema": {
  837. "type": "string",
  838. "required": true,
  839. "immutable": true,
  840. "hidden": true,
  841. "default": "pgBackup"
  842. }
  843. },
  844. {
  845. "variable": "aclEntries",
  846. "label": "ACL Configuration",
  847. "schema": {
  848. "type": "dict",
  849. "show_if": [
  850. [
  851. "aclEnable",
  852. "=",
  853. true
  854. ]
  855. ],
  856. "attrs": [
  857. {
  858. "variable": "path",
  859. "label": "Path",
  860. "description": "Path to perform ACL",
  861. "schema": {
  862. "type": "string",
  863. "hidden": true
  864. }
  865. },
  866. {
  867. "variable": "entries",
  868. "label": "ACL Entries",
  869. "description": "ACL Entries",
  870. "schema": {
  871. "type": "list",
  872. "items": [
  873. {
  874. "variable": "aclEntry",
  875. "label": "ACL Entry",
  876. "schema": {
  877. "type": "dict",
  878. "attrs": [
  879. {
  880. "variable": "id_type",
  881. "label": "ID Type",
  882. "schema": {
  883. "type": "string",
  884. "enum": [
  885. {
  886. "value": "USER",
  887. "description": "Entry is for a USER"
  888. },
  889. {
  890. "value": "GROUP",
  891. "description": "Entry is for a GROUP"
  892. }
  893. ],
  894. "default": "USER"
  895. }
  896. },
  897. {
  898. "variable": "id",
  899. "label": "ID",
  900. "description": "Make sure to check the ID value is correct and aligns with RunAs user context of the application",
  901. "schema": {
  902. "type": "int",
  903. "required": true,
  904. "min": 0
  905. }
  906. },
  907. {
  908. "variable": "access",
  909. "label": "Access",
  910. "schema": {
  911. "type": "string",
  912. "enum": [
  913. {
  914. "value": "READ",
  915. "description": "Read Access"
  916. },
  917. {
  918. "value": "MODIFY",
  919. "description": "Modify Access"
  920. },
  921. {
  922. "value": "FULL_CONTROL",
  923. "description": "FULL_CONTROL Access"
  924. }
  925. ]
  926. }
  927. }
  928. ]
  929. }
  930. }
  931. ]
  932. }
  933. }
  934. ]
  935. }
  936. }
  937. ]
  938. }
  939. },
  940. {
  941. "variable": "hostPathConfig",
  942. "label": "Host Path Configuration",
  943. "schema": {
  944. "type": "dict",
  945. "show_if": [
  946. [
  947. "type",
  948. "=",
  949. "hostPath"
  950. ]
  951. ],
  952. "attrs": [
  953. {
  954. "variable": "aclEnable",
  955. "label": "Enable ACL",
  956. "description": "Enable ACL for the dataset.",
  957. "schema": {
  958. "type": "boolean",
  959. "hidden": true,
  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. }
  1099. },
  1100. {
  1101. "variable": "additionalStorages",
  1102. "label": "Additional Storage",
  1103. "description": "Additional storage for Briefkasten.",
  1104. "schema": {
  1105. "type": "list",
  1106. "default": [],
  1107. "items": [
  1108. {
  1109. "variable": "storageEntry",
  1110. "label": "Storage Entry",
  1111. "schema": {
  1112. "type": "dict",
  1113. "attrs": [
  1114. {
  1115. "variable": "type",
  1116. "label": "Type",
  1117. "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",
  1118. "schema": {
  1119. "type": "string",
  1120. "required": true,
  1121. "default": "ixVolume",
  1122. "immutable": true,
  1123. "enum": [
  1124. {
  1125. "value": "hostPath",
  1126. "description": "Host Path (Path that already exists on the system)"
  1127. },
  1128. {
  1129. "value": "ixVolume",
  1130. "description": "ixVolume (Dataset created automatically by the system)"
  1131. },
  1132. {
  1133. "value": "smb-pv-pvc",
  1134. "description": "SMB Share (Mounts a persistent volume claim to a SMB share)"
  1135. }
  1136. ]
  1137. }
  1138. },
  1139. {
  1140. "variable": "readOnly",
  1141. "label": "Read Only",
  1142. "description": "Mount the volume as read only.",
  1143. "schema": {
  1144. "type": "boolean",
  1145. "default": false
  1146. }
  1147. },
  1148. {
  1149. "variable": "mountPath",
  1150. "label": "Mount Path",
  1151. "description": "The path inside the container to mount the storage.",
  1152. "schema": {
  1153. "type": "path",
  1154. "required": true
  1155. }
  1156. },
  1157. {
  1158. "variable": "hostPathConfig",
  1159. "label": "Host Path Configuration",
  1160. "schema": {
  1161. "type": "dict",
  1162. "show_if": [
  1163. [
  1164. "type",
  1165. "=",
  1166. "hostPath"
  1167. ]
  1168. ],
  1169. "attrs": [
  1170. {
  1171. "variable": "aclEnable",
  1172. "label": "Enable ACL",
  1173. "description": "Enable ACL for the dataset.",
  1174. "schema": {
  1175. "type": "boolean",
  1176. "default": false
  1177. }
  1178. },
  1179. {
  1180. "variable": "acl",
  1181. "label": "ACL Configuration",
  1182. "schema": {
  1183. "type": "dict",
  1184. "show_if": [
  1185. [
  1186. "aclEnable",
  1187. "=",
  1188. true
  1189. ]
  1190. ],
  1191. "attrs": [
  1192. {
  1193. "variable": "path",
  1194. "label": "Host Path",
  1195. "description": "Host Path to perform ACL",
  1196. "schema": {
  1197. "type": "hostpath",
  1198. "required": true,
  1199. "empty": false
  1200. }
  1201. },
  1202. {
  1203. "variable": "entries",
  1204. "label": "ACL Entries",
  1205. "description": "ACL Entries",
  1206. "schema": {
  1207. "type": "list",
  1208. "items": [
  1209. {
  1210. "variable": "aclEntry",
  1211. "label": "ACL Entry",
  1212. "schema": {
  1213. "type": "dict",
  1214. "attrs": [
  1215. {
  1216. "variable": "id_type",
  1217. "label": "ID Type",
  1218. "schema": {
  1219. "type": "string",
  1220. "enum": [
  1221. {
  1222. "value": "USER",
  1223. "description": "Entry is for a USER"
  1224. },
  1225. {
  1226. "value": "GROUP",
  1227. "description": "Entry is for a GROUP"
  1228. }
  1229. ],
  1230. "default": "USER"
  1231. }
  1232. },
  1233. {
  1234. "variable": "id",
  1235. "label": "ID",
  1236. "description": "Make sure to check the ID value is correct and aligns with RunAs user context of the application",
  1237. "schema": {
  1238. "type": "int",
  1239. "required": true,
  1240. "min": 0
  1241. }
  1242. },
  1243. {
  1244. "variable": "access",
  1245. "label": "Access",
  1246. "schema": {
  1247. "type": "string",
  1248. "enum": [
  1249. {
  1250. "value": "READ",
  1251. "description": "Read Access"
  1252. },
  1253. {
  1254. "value": "MODIFY",
  1255. "description": "Modify Access"
  1256. },
  1257. {
  1258. "value": "FULL_CONTROL",
  1259. "description": "FULL_CONTROL Access"
  1260. }
  1261. ]
  1262. }
  1263. }
  1264. ]
  1265. }
  1266. }
  1267. ]
  1268. }
  1269. },
  1270. {
  1271. "variable": "options",
  1272. "label": "ACL Options",
  1273. "schema": {
  1274. "type": "dict",
  1275. "attrs": [
  1276. {
  1277. "variable": "force",
  1278. "label": "Force Flag",
  1279. "description": "Enabling `Force` applies ACL even if the path has existing data",
  1280. "schema": {
  1281. "type": "boolean",
  1282. "default": false
  1283. }
  1284. }
  1285. ]
  1286. }
  1287. }
  1288. ],
  1289. "$ref": [
  1290. "normalize/acl"
  1291. ]
  1292. }
  1293. },
  1294. {
  1295. "variable": "hostPath",
  1296. "label": "Host Path",
  1297. "description": "The host path to use for storage.",
  1298. "schema": {
  1299. "type": "hostpath",
  1300. "show_if": [
  1301. [
  1302. "aclEnable",
  1303. "=",
  1304. false
  1305. ]
  1306. ],
  1307. "immutable": true,
  1308. "required": true
  1309. }
  1310. }
  1311. ]
  1312. }
  1313. },
  1314. {
  1315. "variable": "ixVolumeConfig",
  1316. "label": "ixVolume Configuration",
  1317. "description": "The configuration for the ixVolume dataset.",
  1318. "schema": {
  1319. "type": "dict",
  1320. "show_if": [
  1321. [
  1322. "type",
  1323. "=",
  1324. "ixVolume"
  1325. ]
  1326. ],
  1327. "$ref": [
  1328. "normalize/ixVolume"
  1329. ],
  1330. "attrs": [
  1331. {
  1332. "variable": "aclEnable",
  1333. "label": "Enable ACL",
  1334. "description": "Enable ACL for the dataset.",
  1335. "schema": {
  1336. "type": "boolean",
  1337. "default": false
  1338. }
  1339. },
  1340. {
  1341. "variable": "datasetName",
  1342. "label": "Dataset Name",
  1343. "description": "The name of the dataset to use for storage.",
  1344. "schema": {
  1345. "type": "string",
  1346. "required": true,
  1347. "immutable": true,
  1348. "default": "storage_entry"
  1349. }
  1350. },
  1351. {
  1352. "variable": "aclEntries",
  1353. "label": "ACL Configuration",
  1354. "schema": {
  1355. "type": "dict",
  1356. "show_if": [
  1357. [
  1358. "aclEnable",
  1359. "=",
  1360. true
  1361. ]
  1362. ],
  1363. "attrs": [
  1364. {
  1365. "variable": "path",
  1366. "label": "Path",
  1367. "description": "Path to perform ACL",
  1368. "schema": {
  1369. "type": "string",
  1370. "hidden": true
  1371. }
  1372. },
  1373. {
  1374. "variable": "entries",
  1375. "label": "ACL Entries",
  1376. "description": "ACL Entries",
  1377. "schema": {
  1378. "type": "list",
  1379. "items": [
  1380. {
  1381. "variable": "aclEntry",
  1382. "label": "ACL Entry",
  1383. "schema": {
  1384. "type": "dict",
  1385. "attrs": [
  1386. {
  1387. "variable": "id_type",
  1388. "label": "ID Type",
  1389. "schema": {
  1390. "type": "string",
  1391. "enum": [
  1392. {
  1393. "value": "USER",
  1394. "description": "Entry is for a USER"
  1395. },
  1396. {
  1397. "value": "GROUP",
  1398. "description": "Entry is for a GROUP"
  1399. }
  1400. ],
  1401. "default": "USER"
  1402. }
  1403. },
  1404. {
  1405. "variable": "id",
  1406. "label": "ID",
  1407. "description": "Make sure to check the ID value is correct and aligns with RunAs user context of the application",
  1408. "schema": {
  1409. "type": "int",
  1410. "required": true,
  1411. "min": 0
  1412. }
  1413. },
  1414. {
  1415. "variable": "access",
  1416. "label": "Access",
  1417. "schema": {
  1418. "type": "string",
  1419. "enum": [
  1420. {
  1421. "value": "READ",
  1422. "description": "Read Access"
  1423. },
  1424. {
  1425. "value": "MODIFY",
  1426. "description": "Modify Access"
  1427. },
  1428. {
  1429. "value": "FULL_CONTROL",
  1430. "description": "FULL_CONTROL Access"
  1431. }
  1432. ]
  1433. }
  1434. }
  1435. ]
  1436. }
  1437. }
  1438. ]
  1439. }
  1440. }
  1441. ]
  1442. }
  1443. }
  1444. ]
  1445. }
  1446. },
  1447. {
  1448. "variable": "smbConfig",
  1449. "label": "SMB Share Configuration",
  1450. "description": "The configuration for the SMB Share.",
  1451. "schema": {
  1452. "type": "dict",
  1453. "show_if": [
  1454. [
  1455. "type",
  1456. "=",
  1457. "smb-pv-pvc"
  1458. ]
  1459. ],
  1460. "attrs": [
  1461. {
  1462. "variable": "server",
  1463. "label": "Server",
  1464. "description": "The server for the SMB share.",
  1465. "schema": {
  1466. "type": "string",
  1467. "required": true
  1468. }
  1469. },
  1470. {
  1471. "variable": "share",
  1472. "label": "Share",
  1473. "description": "The share name for the SMB share.",
  1474. "schema": {
  1475. "type": "string",
  1476. "required": true
  1477. }
  1478. },
  1479. {
  1480. "variable": "domain",
  1481. "label": "Domain (Optional)",
  1482. "description": "The domain for the SMB share.",
  1483. "schema": {
  1484. "type": "string"
  1485. }
  1486. },
  1487. {
  1488. "variable": "username",
  1489. "label": "Username",
  1490. "description": "The username for the SMB share.",
  1491. "schema": {
  1492. "type": "string",
  1493. "required": true
  1494. }
  1495. },
  1496. {
  1497. "variable": "password",
  1498. "label": "Password",
  1499. "description": "The password for the SMB share.",
  1500. "schema": {
  1501. "type": "string",
  1502. "required": true,
  1503. "private": true
  1504. }
  1505. },
  1506. {
  1507. "variable": "size",
  1508. "label": "Size (in Gi)",
  1509. "description": "The size of the volume quota.",
  1510. "schema": {
  1511. "type": "int",
  1512. "required": true,
  1513. "min": 1,
  1514. "default": 1
  1515. }
  1516. }
  1517. ]
  1518. }
  1519. }
  1520. ]
  1521. }
  1522. }
  1523. ]
  1524. }
  1525. }
  1526. ]
  1527. }
  1528. },
  1529. {
  1530. "variable": "resources",
  1531. "group": "Resources Configuration",
  1532. "label": "",
  1533. "schema": {
  1534. "type": "dict",
  1535. "attrs": [
  1536. {
  1537. "variable": "limits",
  1538. "label": "Limits",
  1539. "schema": {
  1540. "type": "dict",
  1541. "attrs": [
  1542. {
  1543. "variable": "cpu",
  1544. "label": "CPU",
  1545. "description": "CPU limit for Briefkasten.",
  1546. "schema": {
  1547. "type": "string",
  1548. "max_length": 6,
  1549. "valid_chars": "^(0\\.[1-9]|[1-9][0-9]*)(\\.[0-9]|m?)$",
  1550. "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",
  1551. "default": "4000m",
  1552. "required": true
  1553. }
  1554. },
  1555. {
  1556. "variable": "memory",
  1557. "label": "Memory",
  1558. "description": "Memory limit for Briefkasten.",
  1559. "schema": {
  1560. "type": "string",
  1561. "max_length": 12,
  1562. "valid_chars": "^[1-9][0-9]*([EPTGMK]i?|e[0-9]+)?$",
  1563. "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",
  1564. "default": "8Gi",
  1565. "required": true
  1566. }
  1567. }
  1568. ]
  1569. }
  1570. }
  1571. ]
  1572. }
  1573. }
  1574. ]
  1575. },
  1576. "app_readme": "<h1>Briefkasten</h1>\n<p><a href=\"https://github.com/ndom91/briefkasten\">Briefkasten</a> is a self hosted bookmarking app</p>\n<blockquote>\n<p>When 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>postgres</code> directories.\nAfterward, the <code>postgres</code> container will run as a <strong>non</strong>-root user (<code>999</code>).\nOn each upgrade, a container will be launched with <strong>root</strong> privileges in order to apply the correct\npermissions to the <code>postgres</code> <strong>backups</strong> directory. Container that performs the backup will run as a <strong>non</strong>-root user (<code>999</code>) afterwards.\nKeep in mind the permissions on the backup directory will be changed to <code>999:999</code> on <strong>every</strong> update.\nBut will only be changed once for the <code>postgres</code> data directories.</p>\n</blockquote>",
  1577. "detailed_readme": "<h1>Briefkasten</h1>\n<p><a href=\"https://github.com/ndom91/briefkasten\">Briefkasten</a> is a self hosted bookmarking app</p>\n<blockquote>\n<p>When 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>postgres</code> directories.\nAfterward, the <code>postgres</code> container will run as a <strong>non</strong>-root user (<code>999</code>).\nOn each upgrade, a container will be launched with <strong>root</strong> privileges in order to apply the correct\npermissions to the <code>postgres</code> <strong>backups</strong> directory. Container that performs the backup will run as a <strong>non</strong>-root user (<code>999</code>) afterwards.\nKeep in mind the permissions on the backup directory will be changed to <code>999:999</code> on <strong>every</strong> update.\nBut will only be changed once for the <code>postgres</code> data directories.</p>\n</blockquote>",
  1578. "changelog": null
  1579. }
  1580. }