truecharts/charts/stable/archivebox/docs/installation_guide.md at main

Files

T

gismo2004 3ed35b7668 docs(archivebox) update installation guide (#29814 )

**Description**
update install guide 

⚒️ Fixes  # <!--(issue)-->

**⚙️ 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?**
<!--
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration
-->

**📃 Notes:**
<!-- Please enter any other relevant information here -->

**✔️ Checklist:**

- [ ] ⚖️ My code follows the style guidelines of this project
- [ ] 👀 I have performed a self-review of my own code
- [ ] #️⃣ 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
- [ ] ⬆️ I increased versions for any altered app according to semantic
versioning
- [ ] I made sure the title starts with `feat(chart-name):`,
`fix(chart-name):` or `chore(chart-name):`

**➕ App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`

---

_Please don't blindly check all the boxes. Read them and only check
those that apply.
Those checkboxes are there for the reviewer to see what is this all
about and
the status of this PR with a quick glance._

2024-12-04 16:11:04 +01:00

2.1 KiB

Raw Permalink Blame History

title

title
Installation Guide

Configuration

Configure an initial admin username and password you want to log in within the Web UI (only applied on first setup run).
```
values:
  config:
    admin_username: "admin"
    admin_password: "changeme"
```
If needed, it is possible to set up a persitent storage for archived data.

Example configuration using NFS:
```
values:
  persistence:
    archive:
      enabled: true
      mountPath: /data/archive
      type: nfs
      path: /mnt/Tank/apps/archivebox
      server: ${NAS_IP}
```
Make sure whatever filesystem the data is located on supports FSYNC and doesn't squash permissions. NFS servers may need to set no_root_squash

For more info about ArchiveBox's filesystem requirements, see here:
- ArchiveBox Filesystem Requirements
- ArchiveBox Issue #742 (example of common filesystem issue with NFS)
- ArchiveBox Issue #1304

Optionally add any other ArchiveBox Configuration variables you want

Example:

values:
  workload:
    main:
      podSpec:
        containers:
          main:
            env:
              SNAPSHOTS_PER_PAGE: 10

2.1 KiB

Raw Permalink Blame History

Configuration

Further Reading

Ask For Help

2.1 KiB Raw Permalink Blame History

Configuration

Further Reading

Ask For Help

2.1 KiB

Raw Permalink Blame History