TrueChartsClone/charts/incubator/archivebox/README.md

32 lines
1.2 KiB
Markdown
Raw Normal View History

add(archivebox): Add new ArchiveBox chart (#18258) **Description** Adds new chart for ArchiveBox. https://github.com/truenas/charts/issues/2165 - https://github.com/ArchiveBox/ArchiveBox - https://hub.docker.com/r/archivebox/archivebox - [`Dockerfile`](https://github.com/ArchiveBox/ArchiveBox/blob/main/Dockerfile) - [`docker-compose.yml`](https://github.com/ArchiveBox/ArchiveBox/blob/main/docker-compose.yml) - [`archivebox-kubernetes.yml`](https://github.com/ArchiveBox/docker-archivebox/blob/master/archivebox.yml) - [ArchiveBox Docker Quickstart](https://github.com/ArchiveBox/ArchiveBox#quickstart) + [Usage](https://github.com/ArchiveBox/ArchiveBox/wiki/Docker) + [Configuration](https://github.com/ArchiveBox/ArchiveBox/wiki/Docker#configuration) + [Upgrading](https://github.com/ArchiveBox/ArchiveBox/wiki/Upgrading-or-Merging-Archives) documentation **⚙️ Type of change** - [x] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code **🧪 How Has This Been Tested?** I have tested it as a "Custom App" in TrueNAS scale but have not tested beyond that. Let me know how to test it if there are other mechanisms, I didn't see an way in the docs to load this as yaml into TrueNAS. <img width="998" alt="image" src="https://github.com/truecharts/charts/assets/511499/d4355f84-038c-4b97-87e8-85b46b37dd1d"> **✔️ Checklist:** - [x] ⚖️ My code follows the style guidelines of this project - [x] 👀 I have performed a self-review of my own code - [x] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [x] ⬆️ I increased versions for any altered app according to semantic versioning **➕ App addition** If this PR is an app addition please make sure you have done the following. - [x] 🖼️ I have added an icon in the Chart's root directory called `icon.png`
2024-02-21 17:44:56 +00:00
---
title: README
---
## General Info
TrueCharts can be installed as both _normal_ Helm Charts or as Apps on TrueNAS SCALE.
However only installations using the TrueNAS SCALE Apps system are supported.
For more information about this App, please check the docs on:
- the TrueCharts [website](https://truecharts.org/charts/incubator/archivebox)
- the ArchiveBox [website](https://github.com/ArchiveBox/ArchiveBox)
- the ArchiveBox [wiki](https://github.com/ArchiveBox/ArchiveBox/wiki/Docker)
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/charts/issues/new/choose)**
## Support
- Please check our [quick-start guides for TrueNAS SCALE](https://truecharts.org/manual/SCALE/guides/scale-intro).
- See the [Website](https://truecharts.org)
- Check our [Discord](https://discord.gg/tVsPTHWTtr)
- Open a [issue](https://github.com/truecharts/charts/issues/new/choose)
---
## Sponsor TrueCharts
TrueCharts can only exist due to the incredible effort of our staff.
Please consider making a [donation](https://truecharts.org/sponsor) or contributing back to the project any way you can!
_All Rights Reserved - The TrueCharts Project_