Request to add to unraid CA applications

[soultaco83]

I would like to request permission to add the Nhentai_archivist to the unraid CA applications.
I have access to add it via my repo
https://github.com/soultaco83/unraid-templates

I can create the template and allow you to review if that is something you maybe interested in.
Currently I only have one other one on there and that is a modification of the jellyfin docker container.

[9-FS]

Sure go ahead, but let me review it before publishing.

Good documentation is really important to me, so either copypaste or link the appropriate sections of the readme in there please. Links may be smarter to keep it updated without continuous effort.

I would like to have #26 resolved first though.

[soultaco83]

I was creating the config. Is there a reason behind the 1g memory limit?

[soultaco83]

added the warning

  <Name>nhentai_archivist</Name>
  <Repository>ghcr.io/9-fs/nhentai_archivist:latest</Repository>
  <Registry>https://github.com/9-FS/nhentai_archivist/pkgs/container/nhentai_archivist</Registry>
  <Network>bridge</Network>
  <MyIP/>
  <Shell>bash</Shell>
  <Privileged>false</Privileged>
  <Support>https://github.com/9-FS/nhentai_archivist/issues</Support>
  <Project>https://github.com/9-FS/nhentai_archivist</Project>
  <Overview>Unraid template for 9-FS/nhentai_archivist&#xD;
Advanced options for .env: https://github.com/9-FS/nhentai_archivist/blob/main/readme.md#further-settings&#xD;
# nhentai_archivist&#xD;
&amp;gt; [!WARNING]&#xD;
&amp;gt; I advise against running multiple instances of nHentai Archivist at the same time.&#xD;
## Installation&#xD;
&#xD;
1. Execute the program once to create a default `./config/.env`.&#xD;
    This means that in the directory of the executable, there should now be a directory called "config" containing a file called ".env". You might need to enable seeing hidden files in the file explorer.&#xD;
&#xD;
2. I recommend setting the `CSRFTOKEN` cookie and `USER_AGENT`. If you start having problems with nHentai's bot protection (error 403), setting these is mandatory. If a `CF_CLEARANCE` cookie is available, it should be set as well.&#xD;
    - Mozilla Firefox&#xD;
        1. Go to https://nhentai.net/. Clear the Cloudflare prompt.&#xD;
        2 Open the developer console with F12.&#xD;
        3. Go to the tab "Storage". On the left side expand "Cookies". Click on "https://nhentai.net".&#xD;
        4. Copy the cookie values into `./config/.env`.&#xD;
        5. Go to https://www.whatismybrowser.com/detect/what-is-my-user-agent/ and copy your user agent into `./config/.env`.&#xD;
    - Google Chrome&#xD;
        1. Go to https://nhentai.net/. Clear the cloudflare prompt.&#xD;
        2. Open the developer console with F12.&#xD;
        3. Go to the tab "Application". On the left side under "Storage", expand "Cookies". Click on "https://nhentai.net".&#xD;
        4. Copy the cookie values into `./config/.env`.&#xD;
        5. Go to https://www.whatismybrowser.com/detect/what-is-my-user-agent/ and copy your user agent into `./config/.env`.&#xD;
&#xD;
&amp;gt; &#xD;
&amp;gt; If nHentai has "under attack" mode enabled, clearing the Cloudflare prompt and updating `CF_CLEARANCE` seem to be required daily.&#xD;
&#xD;
</Overview>
  <Category>Downloaders: MediaApp:Books</Category>
  <WebUI/>
  <TemplateURL>https://raw.githubusercontent.com/soultaco83/unraid-templates/refs/heads/master/nhentai_archivist/nhentai_archivist.xml</TemplateURL>
  <Icon/>
  <ExtraParams/>
  <PostArgs/>
  <CPUset/>
  <DateInstalled>1732511495</DateInstalled>
  <DonateText/>
  <DonateLink/>
  <Requires/>
  <Config Name="Hentai" Target="/app/hentai" Default="" Mode="rw" Description="" Type="Path" Display="always" Required="true" Mask="false"/>
  <Config Name="Database" Target="/app/db/" Default="" Mode="rw" Description="" Type="Path" Display="always" Required="false" Mask="false">/mnt/user/appdata/nhentai_archivist/db</Config>
  <Config Name="Log" Target="/app/log/" Default="" Mode="rw" Description="" Type="Path" Display="always" Required="false" Mask="false">/mnt/user/appdata/nhentai_archivist/log/</Config>
  <Config Name="Appdata" Target="/app/config/" Default="" Mode="rw" Description="" Type="Path" Display="advanced" Required="false" Mask="false">/mnt/user/appdata/nhentai_archivist/config</Config>
  <Config Name="PUID" Target="PUID" Default="" Mode="" Description="" Type="Variable" Display="advanced" Required="false" Mask="false">99</Config>
  <Config Name="PGID" Target="PGID" Default="" Mode="" Description="" Type="Variable" Display="advanced" Required="false" Mask="false">100</Config>
  <Config Name="TZ" Target="TZ" Default="" Mode="" Description="" Type="Variable" Display="advanced" Required="false" Mask="false">UTC</Config>
  <Config Name="UMASK" Target="UMASK" Default="" Mode="" Description="" Type="Variable" Display="advanced" Required="false" Mask="false">000</Config>```

Once icon is created I can post submit it. Of course if there are any changes or additions feel free to let me know of anything. 

[soultaco83]

https://github.com/soultaco83/unraid-templates/tree/archivist/nhentai_archivist
I'll move to master once approved so that it can upload

[9-FS]

I was creating the config. Is there a reason behind the 1g memory limit?

It's always a good practice to give containers memory limits so they don't bust your whole system if something unexpected happens *cough Java/JavaScript shenanigans cough*. 1 GiB is the default value I assign containers and that's plenty for nHentai Archivist.

I don't really like how you changed the order of my readme. The warning box is where it is because it refers to the paragraph directly above. It doesn't make that much sense without context.

I say either copy the whole readme and commit to keep it current with every change I make or, what I would prefer, just copy the introduction and link the readme after that.

And I think it would make sense to have all settings available to change in the template with their respective default values set, not just the ones from the docker compose.

[soultaco83]

memory set to 1G
Copied the intro and linked readme

I can add all the options as variables. I thought it would still be needed to set in the .env after first run.

[9-FS]

Thanks.

If these Unraid settings work like environmental variables in docker compose, then they should work out of the box and using the .env should not be necessary.

[soultaco83]

Updated:

I made CSRFTOKEN required and linked to the spot in the readme for obtaining.
I also set the useragent to the current version of user agent. Let me know if you want to leave this blank.
Since blank Filename_title_type defaults to English I set it to English by default. But again I can just leave blank if that is preferred.

Because of the way unraid decides to translate "" I can not directly place the example of tags into the Nhentai_tags variable. But I noted to look at the docker-compose.yaml example in the readme
I was unsure of what the default value of sleep was but from a fresh install it seems to be 50000--> Do you happen to have the unit of measure this is. Seconds, milliseconds?

my-nhentai_archivist.txt

[9-FS]

Introduction part looks good to me now. 👍 Maybe someting like "For more detailled and most up-to-date documentation, read the readme of the GitHub repository." would be nice, but optional at this point.

I made CSRFTOKEN required and linked to the spot in the readme for obtaining.

CSRFTOKEN and USER_AGENT are not required for nHentai Archivist to work initially, so I don't want to make them required fields.

Please implement optionality and default values according to ./src/config.rs:

• DATABASE_URL and LIBRARY_PATH are mandatory, the rest is optional.

• CF_CLEARANCE: None,
  CLEANUP_TEMPORARY_FILES: None,
  CSRFTOKEN: Some("".to_owned()),
  DATABASE_URL: "./db/db.sqlite".to_owned(),
  DEBUG: None, // no entry in default config, defaults to false
  DONTDOWNLOADME_FILEPATH: Some("./config/dontdownloadme.txt".to_owned()),
  DOWNLOADME_FILEPATH: Some("./config/downloadme.txt".to_owned()),
  FILENAME_TITLE_TYPE: None, // no entry in default config, defaults to English
  LIBRARY_PATH: "./hentai/".to_owned(),
  LIBRARY_SPLIT: None, // no entry in default config, defaults to 0
  NHENTAI_TAGS: None,
  SLEEP_INTERVAL: Some(50000),
  USER_AGENT: Some("".to_owned()),

  Instead of None, which would mean no settings entry, you could use their implicit default value, outlined in the comments, though. So for example CF_CLEARANCE gets an empty string as default value, FILENAME_TITLE_TYPE gets "English", LIBRARY_SPLIT gets 0, SLEEP_INTERVAL 50000 and so on.

And yes, the unit of SLEEP_INTERVAL is seconds. You can just copy and paste the settings documentation of my readme though, so I don't know how that answer really helps you.

I have also seen that you have added PUID, PGID, and UMASK. nHentai Archivist does not use these environment variables, so I don't know if they have any effect...