Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

website/integrations: add Immich #7829

Merged
merged 6 commits into from
Dec 15, 2023
Merged

website/integrations: add Immich #7829

merged 6 commits into from
Dec 15, 2023

Conversation

ZuluWhiskey
Copy link
Contributor

@ZuluWhiskey ZuluWhiskey commented Dec 8, 2023

Create documentation for the Immich application

Adding in documentation for Immich. This doesn't close a PR but will help anyone else attempting to set up the application in authentik


Checklist

  • Local tests pass (ak test authentik/)
  • The code has been formatted (make lint-fix)

If an API change has been made

  • The API schema has been updated (make gen-build)

If changes to the frontend have been made

  • The code has been formatted (make web)
  • The translation files have been updated (make i18n-extract)

If applicable

  • The documentation has been updated
  • The documentation has been formatted (make website)

@ZuluWhiskey ZuluWhiskey requested a review from a team as a code owner December 8, 2023 16:40
Copy link

netlify bot commented Dec 8, 2023

Deploy Preview for authentik-storybook ready!

Name Link
🔨 Latest commit 07febfa
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/657c2f710480fa0008f09534
😎 Deploy Preview https://deploy-preview-7829--authentik-storybook.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Dec 8, 2023

Deploy Preview for authentik ready!

Name Link
🔨 Latest commit 07febfa
🔍 Latest deploy log https://app.netlify.com/sites/authentik/deploys/657c2f7119f71800088f2aaa
😎 Deploy Preview https://deploy-preview-7829--authentik.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 97 (🟢 up 4 from production)
Accessibility: 90 (no change from production)
Best Practices: 100 (no change from production)
SEO: 80 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@rissson rissson changed the title Documentation: Create Immich integration documentation website/integrations: add Immich Dec 11, 2023
Copy link
Member

@rissson rissson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, thank you for your contribution! A few minor changes, but all in all looks very good :D (and now I don't have to figure out Immich settings when I'll install it at home)

@rissson rissson requested a review from tanberry December 11, 2023 07:20
Copy link

codecov bot commented Dec 11, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a9dba4e) 92.63% compared to head (07febfa) 92.62%.
Report is 41 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #7829      +/-   ##
==========================================
- Coverage   92.63%   92.62%   -0.01%     
==========================================
  Files         588      588              
  Lines       29200    29200              
==========================================
- Hits        27049    27047       -2     
- Misses       2151     2153       +2     
Flag Coverage Δ
e2e 50.65% <ø> (-0.02%) ⬇️
integration 25.91% <ø> (ø)
unit 89.70% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@rissson
Copy link
Member

rissson commented Dec 11, 2023

Looks like you're missing a make website. If you do not have the tooling, I can run it for you and push it to this PR.

@ZuluWhiskey
Copy link
Contributor Author

Looks like you're missing a make website. If you do not have the tooling, I can run it for you and push it to this PR.

I did spot make website but wasn't sure what it was - I'll take a look at the contribution documentation to see what's required 👍

…plain the list is an example

- Fixed a typo with the word "Confidential"
- Changed placeholder for Immich to be the URL, including https://
@ZuluWhiskey
Copy link
Contributor Author

Looks like you're missing a make website. If you do not have the tooling, I can run it for you and push it to this PR.

Apologies, this is new to me and I'm getting this error and I'm unsure how to resolve it ☹️ If you are able to run it, I'd appreciate it

zuluwhiskey@xxx:~/github/authentik/authentik/website$ nodejs make website-install
node:internal/modules/cjs/loader:1147
  throw err;
  ^

Error: Cannot find module '/home/zuluwhiskey/github/authentik/authentik/website/make'
    at Module._resolveFilename (node:internal/modules/cjs/loader:1144:15)
    at Module._load (node:internal/modules/cjs/loader:985:27)
    at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:135:12)
    at node:internal/main/run_main_module:28:49 {
  code: 'MODULE_NOT_FOUND',
  requireStack: []
}

Node.js v20.10.0

@rissson
Copy link
Member

rissson commented Dec 12, 2023

No worries. The command is simply make website, without nodejs in front.

@ZuluWhiskey
Copy link
Contributor Author

No worries. The command is simply make website, without nodejs in front.

I should've said that I tried that but got this...

zuluwhiskey@x:~/github/authentik/authentik/website$ make website
make: *** No rule to make target 'website'.  Stop.
zuluwhiskey@x:~/github/authentik/authentik/website$ make website-install
make: *** No rule to make target 'website-install'.  Stop.

So tried it with nodejs in front as the documentation says it's required

@ZuluWhiskey
Copy link
Contributor Author

Worked it out, was trying to run the make website command from the /website directory rather than the top directory. Changes pushed

Copy link
Contributor

@tanberry tanberry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much for this contribution! Just a few grammar nitpicks, punctuation, but LGTM!

@ZuluWhiskey
Copy link
Contributor Author

Thanks so much for this contribution! Just a few grammar nitpicks, punctuation, but LGTM!

Thank you, I'll keep the wording / language in mind for an future PRs 😄 All issues mentioned fixed in 07febfa

@rissson rissson enabled auto-merge (squash) December 15, 2023 12:53
@rissson rissson merged commit f9b998e into goauthentik:main Dec 15, 2023
63 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants