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

Files

T

Brendan 231fc2dab1 feat(Archivebox): move from incubator to stable (#21437 )

**Description**
<!--
Please include a summary of the change and which issue is fixed. Please
also include relevant motivation and context. List any dependencies that
are required for this change.
-->

Tested local install; works with defaults, ready for stable.

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

**⚙️ Type of change**

- [x] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [x] ⚠️ 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:**

- [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
- [x] 📄 I have made corresponding changes to the documentation
- [x] ⚠️ My changes generate no new warnings
- [x] 🧪 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
- [x] 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._

---------

Co-authored-by: StevenMcElligott <89483932+StevenMcElligott@users.noreply.github.com>

2024-04-28 09:57:58 +03:00

4.1 KiB

Raw Blame History

title

title
Installation Guide

SCALE App

to setup archivebox:

App Configuration > Admin Username & Admin Password Configure an initial admin username and password you want to log in with in the Web UI (only applied on first setup run).
Networking and Services > Service's Port(s) Configuration > Port Configure the port you want to access the ArchiveBox web interface on, or use the pre-populated default.
Storage and Persistence > App Data Storage Setup persistent a persistent storage volume to use for your ArchiveBox /data directory. We recommend using a Host Path with Automatic Permissions Configuration disabled. ^{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 + no_all_squash)} For more info about ArchiveBox's filesystem requirements, see here:
- ArchiveBox Filesystem Requirements
- ArchiveBox Troubleshooting: Filesystems, NFS, FSYNC
- ArchiveBox Issue #742 (example of common filesystem issue with NFS)
Containers > Main Container > Extra Environment Variables (optional) Optionally add any other ArchiveBox Configuration variables you want here.

✅ Then click Install at the bottom, and wait a few minutes for it to finish deploying.
Once deployed, click Applications > ArchiveBox > Web Portal to access ArchiveBox . Click the Log In (upper right) and proceed with the admin username and password you configured above. Optionally change your password from the initial value by going to Account in the navbar (/admin/password_change/). Click Add in the menubar to get started adding new URLs to archive.

4.1 KiB

Raw Blame History

SCALE App

Further Reading

Ask For Help

4.1 KiB Raw Blame History

SCALE App

Further Reading

Ask For Help

4.1 KiB

Raw Blame History