feat(docs): obtainium usage information and generator#20574
feat(docs): obtainium usage information and generator#20574NicholasFlamy wants to merge 4 commits intoimmich-app:mainfrom
Conversation
github-actions
bot
added
the
documentation
NicholasFlamy
added
changelog:documentation
documentation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| </label> | ||
| </p> | ||
| </form> | ||
| <a hidden={!(inputUrl && inputApiKey && archVariant)} href={obtainiumUrl} target="_blank"> |
Check warning
Code scanning / CodeQL
DOM text reinterpreted as HTML Medium documentation
| let [inputUrl, setInputUrl] = useState(''); | ||
| let [inputApiKey, setInputApiKey] = useState(''); | ||
| let [archVariant, setArchVariant] = useState(''); | ||
| let obtainiumUrl = `https://apps.obtainium.imranr.dev/redirect?r=obtainium://app/%7B%22id%22%3A%22app.alextran.immich%22%2C%22url%22%3A%22${inputUrl}%2Fapi%2Fserver%2Fapk-links%22%2C%22author%22%3A%22Immich%22%2C%22name%22%3A%22Immich%22%2C%22preferredApkIndex%22%3A0%2C%22additionalSettings%22%3A%22%7B%5C%22intermediateLink%5C%22%3A%5B%5D%2C%5C%22customLinkFilterRegex%5C%22%3A%5C%22%5C%22%2C%5C%22filterByLinkText%5C%22%3Afalse%2C%5C%22skipSort%5C%22%3Afalse%2C%5C%22reverseSort%5C%22%3Afalse%2C%5C%22sortByLastLinkSegment%5C%22%3Afalse%2C%5C%22versionExtractWholePage%5C%22%3Afalse%2C%5C%22requestHeader%5C%22%3A%5B%7B%5C%22requestHeader%5C%22%3A%5C%22User-Agent%3A%20Mozilla%2F5.0%20(Linux%3B%20Android%2010%3B%20K)%20AppleWebKit%2F537.36%20(KHTML%2C%20like%20Gecko)%20Chrome%2F114.0.0.0%20Mobile%20Safari%2F537.36%5C%22%7D%2C%7B%5C%22requestHeader%5C%22%3A%5C%22x-api-key%3A%20${inputApiKey}%5C%22%7D%5D%2C%5C%22defaultPseudoVersioningMethod%5C%22%3A%5C%22partialAPKHash%5C%22%2C%5C%22trackOnly%5C%22%3Afalse%2C%5C%22versionExtractionRegEx%5C%22%3A%5C%22%2Fv(%5C%5C%5C%5Cd%2B).(%5C%5C%5C%5Cd%2B).(%5C%5C%5C%5Cd%2B)%2F%5C%22%2C%5C%22matchGroupToUse%5C%22%3A%5C%22%241.%242.%243%5C%22%2C%5C%22versionDetection%5C%22%3Atrue%2C%5C%22useVersionCodeAsOSVersion%5C%22%3Afalse%2C%5C%22apkFilterRegEx%5C%22%3A%5C%22${archVariant}%24%5C%22%2C%5C%22invertAPKFilter%5C%22%3Afalse%2C%5C%22autoApkFilterByArch%5C%22%3Atrue%2C%5C%22appName%5C%22%3A%5C%22%5C%22%2C%5C%22appAuthor%5C%22%3A%5C%22%5C%22%2C%5C%22shizukuPretendToBeGooglePlay%5C%22%3Afalse%2C%5C%22allowInsecure%5C%22%3Afalse%2C%5C%22exemptFromBackgroundUpdates%5C%22%3Afalse%2C%5C%22skipUpdateNotifications%5C%22%3Afalse%2C%5C%22about%5C%22%3A%5C%22%5C%22%2C%5C%22refreshBeforeDownload%5C%22%3Afalse%7D%22%2C%22overrideSource%22%3Anull%7D`; |
There was a problem hiding this comment.
apkFilterRegEx needs .apk before the $.
Could probably also use APKLinkHash for defaultPseudoVersioningMethod, since the version is in the URL.
There was a problem hiding this comment.
I could probably add .apk in case we ever get iOS .ipa releases but currently I'm not including it and I don't have $ at the end.
There was a problem hiding this comment.
I mentioned that because it does insert a $ at the end. The %24 after ${archVariant} is a $.
edit: which makes the regex fail because there's a .apk at the end of the filenames.
There was a problem hiding this comment.
You know, I seem to remember leaving a $ in there and having to remove it. I guess I forgot to update that and push the change. I appreciate the review!
Edit: I'll have to see if I can do that and rebase tonight.
There was a problem hiding this comment.
Oh wait, I updated it in my newer PR, can you review this there?
#20589
3 participants
Description
This has a link generator page in the docs to make use of the API endpoint from #18700.
How Has This Been Tested?
Screenshots (if appropriate)
Checklist:
src/services/uses repositories implementations for database calls, filesystem operations, etc.src/repositories/is pretty basic/simple and does not have any immich specific logic (that belongs insrc/services/)