Skip to content

website/docs: Balok pr for User docs#7139

Merged
BeryJu merged 25 commits intomainfrom
balok-PR
Oct 12, 2023
Merged

website/docs: Balok pr for User docs#7139
BeryJu merged 25 commits intomainfrom
balok-PR

Conversation

@tanberry
Copy link
Contributor

This is an expansion of @balok's original PR in the hackathon. Full credit to Balok; I just edited and then finished writing the invitations.md topic. :-)

@tanberry tanberry requested a review from a team as a code owner October 10, 2023 16:52
@netlify
Copy link

netlify bot commented Oct 10, 2023

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit 6a84386
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/65284a8bc2e9170008b8a0a0

@tanberry tanberry marked this pull request as draft October 10, 2023 16:52
@authentik-automation
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 47.9%, saving 156.85 KB.

Filename Before After Improvement Visual comparison
website/docs/user-group/user/create_invite.png 327.73 KB 170.88 KB -47.9% View diff

185 images did not require optimisation.

@netlify
Copy link

netlify bot commented Oct 10, 2023

👷 Deploy Preview for authentik processing.

Name Link
🔨 Latest commit fcf4530
🔍 Latest deploy log https://app.netlify.com/sites/authentik/deploys/65258161eeada40008dcd1fe

@netlify
Copy link

netlify bot commented Oct 10, 2023

Deploy Preview for authentik ready!

Name Link
🔨 Latest commit 6a84386
🔍 Latest deploy log https://app.netlify.com/sites/authentik/deploys/65284a8bc6714100081b6704
😎 Deploy Preview https://deploy-preview-7139--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: 96 (no change 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.

@codecov
Copy link

codecov bot commented Oct 10, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (b503379) 26.34% compared to head (6a84386) 49.28%.
Report is 2 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #7139       +/-   ##
===========================================
+ Coverage   26.34%   49.28%   +22.95%     
===========================================
  Files         568      568               
  Lines       28049    28049               
===========================================
+ Hits         7387    13822     +6435     
+ Misses      20662    14227     -6435     
Flag Coverage Δ
e2e 47.53% <ø> (?)
integration 26.34% <ø> (ø)

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

see 270 files with indirect coverage changes

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

### Create a user

> If you want to automate user creation, you can do that either by [invitations](./invitations.md), [user write stage](../../flow/stages/user_write), or [using the API](/developer-docs/api/browser).

Copy link
Contributor

Choose a reason for hiding this comment

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

If you can automate creating new users by:

  • Invitations: Invite your users to create their own accounts
  • Using the API: Create user accounts through automated scripting

Looking at the contents of /stages/user_write in the API (I couldn’t find /flow/stages/user_write in the API, and the URL http://localhost:9000/if/admin/#/flow/stages/user_write in the WebUI gives me a 404), this looks much more like “how I define the user_write stage for a new user flow,” and not “how I define a new user and use the Flow to put them into the system.”

{
    name: string
    flow_set: [{
        name: string
        slug: string
        title: string
        designation: enum
        policy_engine_mode: enum
        compatibility_mode: boolean
        layout: enum
        denied_action: enum
    }]
    user_creation_mode: enum
    create_users_as_inactive: boolean
    user_path_template: string
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In a future PR I will attempt to clarify the use of the user_write stage. I just want to get these basic CRUD procedurals out now.

@tanberry tanberry marked this pull request as ready for review October 10, 2023 22:55
@github-actions
Copy link
Contributor

github-actions bot commented Oct 12, 2023

authentik PR Installation instructions

Instructions for docker-compose

Add the following block to your .env file:

AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-balok-PR-1697140098-6a84386
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s

For arm64, use these values:

AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-balok-PR-1697140098-6a84386-arm64
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s

Afterwards, run the upgrade commands from the latest release notes.

Instructions for Kubernetes

Add the following block to your values.yml file:

authentik:
    outposts:
        container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
image:
    repository: ghcr.io/goauthentik/dev-server
    tag: gh-balok-PR-1697140098-6a84386

For arm64, use these values:

authentik:
    outposts:
        container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
image:
    repository: ghcr.io/goauthentik/dev-server
    tag: gh-balok-PR-1697140098-6a84386-arm64

Afterwards, run the upgrade commands from the latest release notes.

@tanberry tanberry requested a review from BeryJu October 12, 2023 16:47
tanberry and others added 4 commits October 12, 2023 12:41
@BeryJu BeryJu merged commit 78af350 into main Oct 12, 2023
@BeryJu BeryJu deleted the balok-PR branch October 12, 2023 19:45
kensternberg-authentik added a commit that referenced this pull request Oct 13, 2023
There were some HEAVY merge bugs in the translation files.

* main:
  providers/scim: remove preview (#7166)
  web: bump the wdio group in /tests/wdio with 4 updates (#7160)
  translate: Updates for file web/xliff/en.xlf in zh_CN (#7162)
  translate: Updates for file web/xliff/en.xlf in zh-Hans (#7161)
  translate: Updates for file web/xliff/en.xlf in zh-Hans (#7158)
  website/docs: Balok pr for User docs (#7139)
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