ombi-app / ombi.docs Goto Github PK

Describe the error

The current NGINX subdirectory reverse proxy example has proxy_redirect duplicated twice in the helper proxy.conf configuration.

Location

https://docs.ombi.app/info/reverse-proxy/#location-block

Suggested correction

The proxy_redirect option should only appear once.

I believe proxy_redirect http:// $scheme://; should be enough? It is more flexible to any environment or base URL configuration?

Will need to spin up an instance to test with for examples

Source reference:
https://github.com/mkdocs/mkdocs/wiki

A few references

• https://github.com/GhostWriters/DockSTARTer/blob/master/mkdocs.yml
• https://github.com/selfhosters/selfhosters.net/blob/master/mkdocs.yml
• https://github.com/pi-hole/docs/blob/master/mkdocs.yml

Guides

• guides/discover
• guides/donate
• guides/issues
• guides/preferences
• guides/requests-list
• guides/usermanagement
  Settings
• settings/About
• settings/Couchpotato
• settings/Emby
• settings/FailedRequests
• settings/Jellyfin
• settings/Logs
• settings/Plex
• settings/Sickrage
  Notifications
• settings/notifications/Cloudmobile
• settings/notifications/gotify
• settings/notifications/mattermost
• settings/notifications/mobile
• settings/notifications/Pushover
• settings/notifications/Slack
• settings/notifications/webhook

Describe the error
These are some updated steps to help with migrating the DB when using a docker instance

Location
What page in the docs does the error appear on?

Suggested correction
The current docs describe the multi database migration. The steps would probably be similar but mine focus on moving to a single database.

P: How to migrate to a single database using docker?

#1 Setup your MariaDB first and create your Ombi database and ombi user. You can find help for the Single Database Setup here: https://docs.ombi.app/info/alternate-databases/#create-database-and-user

#2 Install python3 in your ombi docker container. The following command will get you a bash instance inside your ombi docker container.

Run docker exec ombi bash

From the bash prompt install the appropriate python3 tools

apt update; apt install python3 python3-mysqldb -y;

#3 Copy the python scripts to /config or create a migrate folder and mount that volume in your container.
Help for the script here: https://docs.ombi.app/guides/migrating-databases/#1-requirements

In the docker storage config, mount the ombi_sqlite_mysql folder to the container (we recommend mounting it as /migrate).

#4 Create a database.json file by running this command in docker ombi bash:
python3 ombi_sqlite2mysql.py -c /config --only_db_json --host --db Ombi --user --passwd

#5 Restart the docker container. This will create tables in the MariaDB Ombi database and your instance should start with the original setup wizard.

#6 Run this command in docker bash to kickoff your data migration
python3 ombi_sqlite2mysql.py -c /config --host --db Ombi --user --passwd

#7 Restart the container and you should be greeted with a login window. Once you're logged in go to Settings and confirm that the Ombi Database now shows MySQL

Screenshots
If applicable, add screenshots to help explain your problem.

Method of access:

• OS: Any
• Docker
• Browser: [e.g. Chrome, Firefox, Safari, Opera, Edge]

Additional context
Could probably use some clarification on step 3. I personally uploaded all the python migration scripts to my config folder because it was easier than messing with getting an additional volume mounted.

Add pages under guides/ to match explanations of existing pages.

• Discover
• Requests-List
• Issues (include links with issues in settings)
• UserManagement (include links with users in settings)
• Donate (only shown to admins, explain this, include link to donate to tidus)
• Feature Suggestion (page already exists, add to nav under guides)
• Preferences (per user, QR links to mobile app, include links to mobile app pages)

Take new screenshots for:

• main page
• each settings page
• etc

Yo wtf, the exe file version of the auto updater script is actually infected ?!

Originally posted by @Yw0ke in Ombi-app/Ombi#1460 (comment)

Look into a way to have code blocks scroll instead of wrapping. Looks weird.
Possible css override on theme files?

Put a page in place with "reporting a bug" for ombi, and for ombi.docs

Create issue templates for docs repo.

• Build map of Ombi UI
• Configure URLs on docs to match
• Add mkdocs-redirect to make friendly links for combined/alternate URLs

redirect https://docs.ombi.app/installation/ to https://docs.ombi.app/guides/installation/ in mkdocs

Add link to reverse proxy info in https://docs.ombi.app/settings/ombi/#base-url

I think the docs really should mention that the tables will be created with the servers default collation (perhaps we should be specifying collation on table creation), it does mention the characterset but doesnt mention collation.

For example, MariaDB default collation is latin1_swedish_ci, and this will cause a load of issues with ombi pertaining to special characters, switching to utf8mb4_unicode_ci resolves it of course

Describe the error
There is no clear way how to package Ombi in repositories/build it from source, making it difficult for package maintainers to ship Ombi in distro's repos.

Oh. Oh no. This part will suck.

Add the following line to either the beginning or end of every page.
--8<-- "assets/glossary.md"

Google Analytics

The material theme supports analytics on docs.
Worth doing?

It's time.
All content has been migrated.

• Replace old wiki front page with a link to the new site
• Empty custom sidebar links to discourage browsing
• Pull entire old wiki into archive branch of new docs repo for history? Yes/No?

Add space between # and timeout

https://docs.ombi.app/info/reverse-proxy/

On this page, it says "This configuration is if you want to run a subdirectory configuration. Note, Ombi must be started with the --baseurl /ombi option"

But does not say how to actually do that for each type of installation. Windows etc fine easy enough.. but Linux.. whereby it's started with service ombi start etc.. how exactly do you go about adding this and other arguments?

Install, Update, FAQ under top-level.

Move faults from FAQ to common errors.

Common errors to Info.

Ties in with #39 for user experience

Simply creating a webhook and submitting it appears to not work the way it should.
Need to add explanations for each of the three fields on the page, then a step-by-step to configure it.

Take screenshots at each stage of config, upload to assets folder.

Using the latest version of the OMBI mobile iOS app.

Recently had a change in ISP and broke my port forwards, deleted and redownloaded the app then tried to map to my public URL for OMBI, it works in the mobile browser but not in the app, my server doesnt show the QR code either, not always anyway, when it did earlier today it also failed.

Describe the error
To enable full debug logging, you also need to set Serilog.MinimumLevel to Debug in the appsettings.json
This is used by our custom log method. (Ombi-app/Ombi#4566)

Location
https://docs.ombi.app/info/faq/#how-do-i-enable-debug-logging

Suggested correction

"Logging": {
    "IncludeScopes": false,
    "LogLevel": {
      "Default": "Debug",
      "System": "Debug",
      "Microsoft": "Warning",
      "Hangfire": "None",
      "System.Net.Http.HttpClient.health-checks": "Warning",
      "HealthChecks": "Warning"
    }
  },
  "Serilog": {
    "MinimumLevel": "Debug"
  },

• Add links between FAQ/Common Errors
• Move errors from FAQ to errors
• Move questions from errors to FAQ

Add why v4 is not :latest
why development
reverse proxy things
Plex movies agent

I'm seeing strange issues on processing tv and movies such as the following screenshots.

At first I thought it was requestrr but then I tried directly in Ombi here:

change mkdocs plugin
format dd-mm-yyyy?

That layout does not want to migrate and generates a hot mess. Going to need a complete rewrite.
Ideally, embed the migration script into the assets/scripts folder.

Maybe have the migration built into ombi itself?

Find all instances of alternate domains (ie domain.tld, your.domain etc)
replace with example.com, ombi.example.com, site.example.com.

Refer RFC2606