website/integrations: add engomo

[nicedevil007]

Details

This is my guide to get authentik up and running with Engomo. This application is a low code platform to create apps on android/iOS and iPadOS. I was able to run this appication after 10 minutes setup time on authentik.
This was done (by accident) because we struggled with an other IDP from an other manufacturer. I just wanted to see if authentik is "quick & dirty" to setup :)

I hope the formatting is done "ok", I used my old PR for the documentation on the fortigate-admin guide.

---

Checklist

• Local tests pass (ak test authentik/)

If applicable

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

[netlify]

✅ Deploy Preview for authentik-storybook canceled.

Name	Link
🔨 Latest commit	f6e5f6b
🔍 Latest deploy log	https://app.netlify.com/sites/authentik-storybook/deploys/66a52905ebb3dd0008d8531d

[netlify]

✅ Deploy Preview for authentik-docs ready!

Name	Link
🔨 Latest commit	f6e5f6b
🔍 Latest deploy log	https://app.netlify.com/sites/authentik-docs/deploys/66a52905e2f463000836e072
😎 Deploy Preview	https://deploy-preview-10538--authentik-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.50%. Comparing base (f5e8c28) to head (f6e5f6b).
Report is 77 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #10538      +/-   ##
==========================================
- Coverage   92.62%   92.50%   -0.12%     
==========================================
  Files         714      719       +5     
  Lines       35008    35197     +189     
==========================================
+ Hits        32425    32558     +133     
- Misses       2583     2639      +56     

Flag	Coverage Δ
e2e	49.56% <ø> (-0.04%)	⬇️
integration	25.35% <ø> (-0.02%)	⬇️
unit	90.00% <ø> (-0.12%)	⬇️

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.

[tanberry]

Hi @nicedevil007 thanks for this contribution! I'll give it a review as soon as possible.

It looks like the lint-prettier build check failed... can you run make website or npm run prettier again, and repush, please?

Oh, also, you'll need to add it to the sidebarsIntegrations.jx file so that it appears in the ToC!

[nicedevil007]

Hi @nicedevil007 thanks for this contribution! I'll give it a review as soon as possible.

It looks like the lint-prettier build check failed... can you run make website or npm run prettier again, and repush, please?

Oh, also, you'll need to add it to the sidebarsIntegrations.jx file so that it appears in the ToC!

Trank you for your quick response, never had to use these commands before, so I guess I have to pull this to linux Shell and run These commands inside the Shell Right?

[tanberry]

Thanks again @nicedevil007! Lots of nits in my review, let me know if any questions, or if I changed something and mucked it up technically. Once these changes are made, let's merge!

[tanberry]

Hi @nicedevil007 thanks for this contribution! I'll give it a review as soon as possible.
It looks like the lint-prettier build check failed... can you run make website or npm run prettier again, and repush, please?
Oh, also, you'll need to add it to the sidebarsIntegrations.jx file so that it appears in the ToC!

Trank you for your quick response, never had to use these commands before, so I guess I have to pull this to linux Shell and run These commands inside the Shell Right?

Yes, in your terminal or shell, in the branch run the command make website... are you currently not working in a terminal, but instead using the GitHub UI? I do think it is easier (haha maybe cause it is only way I know) to work in a terminal. Here are our Docs on making contributions to... our Docs. https://docs.goauthentik.io/developer-docs/docs/writing-documentation

Let me know if any questions. We appreciate the contributions!

[nicedevil007]

Don't know how/what to do with this. Do you mean the name? I can use anything more "standardized" if you want. All my SP's got the SP- in front of the apps name.

[4d62]

@tanberry does anything else come to mind here? think it's close to ready for merge after these last few things

[tanberry]

@nicedevil007 it looks like the lint-prettier check is still failing. Did you want to run the build locally so that you can run make website, or would you prefer I do that and push to your PR?

If you want to run locally I am here to help you with that process. It will make future PRs much more simple. ;-)

[nicedevil007]

@nicedevil007 it looks like the lint-prettier check is still failing. Did you want to run the build locally so that you can run make website, or would you prefer I do that and push to your PR?

If you want to run locally I am here to help you with that process. It will make future PRs much more simple. ;-)

no I wasn't successfull with this :(
I already wrote you an email (I took the one from github), I guess you didn't notice it.

so yeah I need help with this.

I have linux servers here and I have my windows machine.
I think first step is to pull the repo locally with my patch for the PR right? And then the "missunderstanding for me starts", how to switch from master to my PR that is a different branch and then where should I navigate to run make website?

What prerequisits are needed to run make website (only default build-essentials?)

[4d62]

I think first step is to pull the repo locally with my patch for the PR right? And then the "missunderstanding for me starts", how to switch from master to my PR that is a different branch

git pull https://github.com/myusername/authentik && cd authentik && git switch patch-1 (or your branch)

where should I navigate to run make website?

at project root. notice the Makefile https://github.com/goauthentik/authentik/blob/main/Makefile defined

authentik/Makefile

Line 239 in 3f30ccf

website: website-lint-fix website-build ## Automatically fix formatting issues in the Authentik website/docs source code, lint the code, and compile it

[nicedevil007]

forget everything about this, and please if you are so kind and help me out doing this prettier stuff

i was able to directly pull my patch branch then there was no prettier installed then there was no docusaurus and there was no codespell... sry but that is that much of effort that most of the time I get an error during the setup that it is more time investing than just writing the guide :(

[4d62]

please if you are so kind and help me out doing this prettier stuff

to be honest, you don't need the entire dev env for prettier. just npm i -g prettier and npx prettier --write path/to/file.mdx

[4d62]

@tanberry dev env is annoying / too overcomplicated to install. especially for people who never contributed to the project. i never even bothered to set it up

[nicedevil007]

@4d62 or @tanberry can you please help me and do the prettier thingi for me? at least I would need a step by step guide for which linux distro it is working and that seems to take much more time right?

[4d62]

@4d62 or @tanberry can you please help me and do the prettier thingi for me? at least I would need a step by step guide for which linux distro it is working and that seems to take much more time right?

1. get on the command line of any debian based distro (ex: ubuntu) there are plenty of guides online related to linux install
2. follow guide to setup https://github.com/nvm-sh/nvm
3. nvm use 22
4. git clone https://github.com/<your github username>/<authentik repo name> authentik-contrib
5. cd authentik-contrib
6. git switch <name of branch you use for this pr>
7. npm i -g prettier
8. npx prettier --write path/to/engomo/markdown.mdx
9. git add . && git commit -m "p" && git push origin <your-pull-request-branch>

[nicedevil007]

@4d62 or @tanberry can you please help me and do the prettier thingi for me? at least I would need a step by step guide for which linux distro it is working and that seems to take much more time right?

1. get on the command line of any debian based distro (ex: ubuntu) there are plenty of guides online related to linux install
2. follow guide to setup https://github.com/nvm-sh/nvm
3. nvm use 22
4. git clone https://github.com/<your github username>/<authentik repo name> authentik-contrib
5. cd authentik-contrib
6. git switch <name of branch you use for this pr>
7. npm i -g prettier
8. npx prettier --write path/to/engomo/markdown.mdx
9. git add . && git commit -m "p" && git push origin <your-pull-request-branch>

This should be added to the documentation for contributors :)

[4d62]

I do believe a good part of the contributors or new contributors will be able to install things without help but I'll create a pr later today with general install steps and suggestions for installation of dependencies (ex: use nvm to manage node and so on)

[nicedevil007]

I do believe a good part of the contributors or new contributors will be able to install things without help but I'll create a pr later today with general install steps and suggestions for installation of dependencies (ex: use nvm to manage node and so on)

Thats possibly true, sorry that I struggled with it :( But with your help learned it, or at least know what to do for other PRs here. I useally edit the Part I Need in the Web directly on github and make the PR then. Most of the time this was Enough ;)

Do I have to do anything Else (still 6 errors?) do get this PR merged?

[4d62]

the remaining errors look to be from ci with that build permission thing i asked about some time back. should be fine to ignore. now you'll just have to wait on one of the project maintainers to do a last review and merge this

[tanberry]

Oh gosh, @nicedevil007 I am so sorry that I did not see your messages (GitHub nor email) from earlier in the week! I am really sad that I was not faster in replying and helping... thank you @4d62 for your help!

Yes, it is a bit more work to fork and clone the authentik repo, and be able to work on it locally. However... I am pretty sure it can be a lot more simple than the route I think you took. And, being able to build locally, and run the linters, results in much higher-quality contributions.

I agree with @4d62 that it would be good to have documentation around how to set up your environment for Docs contributions, without trying to build the whole dev environment. The challenge around such docs is that everyone does things differently, but we can, in the docs, stick to the bare basics.

When we have those docs in a PR, perhaps you could help review them and add anything from your painful lessons learned? :-)

[nicedevil007]

learned? :-)

Oh at least it wasn't such a pain with the help of @4d62 :) I setup a fresh LXC ubuntu 24.04 and did the commands from above. Had to install curl and git by myself and the NVM stuff from their gitrepo and the markdown file was called different ofc.

Thank you very much for the merge :)