Files
truecharts/charts/stable/cloudreve/docs/installation_notes.md
T
StevenMcElligott f8affccb71 chore(docs): Fix broken links for Starlight (#20737)
**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.
-->
⚒️ Fixes  # <!--(issue)-->

**⚙️ Type of change**

- [ ] ⚙️ 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._

---------

Signed-off-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>
Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>
2024-04-14 08:35:59 +03:00

2.5 KiB

title
title
Important Notes

Credentials

On first run, cloudreve will generate an admin user and print the email and password to the app logs. It will look something like this:

   ___ _                 _
  / __\ | ___  _   _  __| |_ __ _____   _____
 / /  | |/ _ \| | | |/ _  | '__/ _ \ \ / / _ \
/ /___| | (_) | |_| | (_| | | |  __/\ V /  __/
\____/|_|\___/ \__,_|\__,_|_|  \___| \_/ \___|

   V3.8.3  Commit #88409cc  Pro=false
================================================

[Info]    2024-01-22 03:27:02 Initializing database connection...
[Info]    2024-01-22 03:27:02 Start initializing database schema...
[Info]    2024-01-22 03:27:03 Admin user name: admin@cloudreve.org
[Info]    2024-01-22 03:27:03 Admin password: 8vLCPvDl
[Info]    2024-01-22 03:27:06 Start executing database script "UpgradeTo3.4.0".
[Info]    2024-01-22 03:27:06 Finish initializing database schema.
[Info]    2024-01-22 03:27:06 Initialize task queue with WorkerNum = 10
[Info]    2024-01-22 03:27:06 Initialize crontab jobs...
[Info]    2024-01-22 03:27:06 Current running mode: Master.
[Info]    2024-01-22 03:27:06 Listening to ":5212"

To retrieve the password in TrueNAS SCALE, wait for the app to finish deploying and then navigate to the Workload card and click the View Logs icon.

Aria2

To use cloudreve with aria2, install the TrueCharts aria2 app. The installation dialog will ask for a RPC Secret, which should be a securely generated string that will be copied to cloudreve later. See below for an example.

Once aria2 is installed, open cloudreve's webpage and navigate to the Dashboard (Click on profile icon in top right corner -> Dashboard). In the dashboard, select Nodes and then click the edit icon beside Master (Local Machine). In the edit dialog, click Enable and then fill out the settings:

  • RPC Server: find with heavyscript dns, and read about internal DNS here.
  • RPC Secret: Set the shared secret here. Must also be set in the Aria2 app.
  • Absolute Path: Set this to a custom persistent mount that you've created for this cloudreve app, and have also mounted to Aria2.

Example RPC Secrete Generation

Below is an example of one way to generate the RPC Secret value. If you do not have a computer with openssl installed, you can use the shell (System Settings -> Shell) in TrueNAS SCALE. Copy the resulting value by highlighting it and pressing Ctrl+Insert.

$ openssl rand -hex 32