[{"_1":2,"_161":-5,"_162":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_140":141},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_129":-5,"_130":11,"_131":21,"_132":11,"_133":-5,"_134":11,"_135":-5,"_136":137,"_138":91,"_139":-7},"canonicalUrl","https://hub.docker.com/r/eeshugerman/invite0/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","eeshugerman","reponame","invite0","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2019-11-12T07:13:04.144528Z","description","easy invite-only Auth0 tenants","is_private","last_updated","2021-07-09T02:56:59.39429Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",1187,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","> **NOTE**: Auth0 recently introduced [Organizations](https://auth0.com/docs/organizations) which includes some [email invite functionality](https://auth0.com/docs/organizations/send-membership-invitations). I haven't looked into it closely, but you should, as it may yield Invite0 obsolete. It's unclear to me if it's included in the free tier -- let me know if you find out!\n\n# Overview\n\n## What is it?\nInvite0 is a small web app which augments the popular [Auth0](https://auth0.com) service, providing code-free support for \"invite only\" tenants.\n\n## The problem\nBy default, your Auth0 tenant is open for signup to anyone on the web. This may or may not be what you want; let's suppose it's not. Fortunately, signups can be easily disabled in the UI. Cool! But now... how do you add users? You might hope that invitation links could be sent to email addresses from the UI, but unfortunately Auth0 does not support this out-of-the-box. Rather, your options are:\n\n 1. create users manually in the UI and by some means send credentials to new users (yuck!)\n 2. handle user creation in your application code via the Management API\n\n(1) poses glaring problems for security and scalability. (2) may be a fine option _if you're developing an application_ -- but what if you are simply integrating software that you do not develop? This is where Invite0 comes in to play.\n\n## The solution\nThe core functionality of Invite0 boils down to three web pages:\n- `/admin`: From this page, Auth0 users with a certain permission can send invitations to email addresses.\n- `/signup/`: This is where the recipients land when they click the invitation link. It's a basic form: password and password confirmation (and additional profile fields if so configured).\n- `/my-account`: Here users can make changes to their account, such as setting a profile picture or changing their password.\n\n`token` is a JSON Web Token (JWT) which encodes the user's email address and the current time in a signed, url-safe string. When the admin clicks `Send`, the user's invite link, `https:///signup/`, is emailed to them. When the user follows the link, the `/signup` view checks the token. Since the token is signed, we can verify that it was encoded with our `SECRET_KEY` (or in other words, that it has not been tampered with). From the token, we decode the email address and creation time, and check that it has not expired per `INVITE_EXPIRATION_DAYS`. Finally, when the user submits the password form, their account is created in Auth0 with the Mangement API.\n\nThis approach enables us to send single-use, temporary invite links, and verifies email address as part of the process, all without touching a database! Token encoding and decoding is handled by [`itsdangerous`](https://github.com/pallets/itsdangerous).\n\n# Installation\n\n### 1. Setup the API and Application in the Auth0 UI\n#### 1. API\n 1. `APIs` -> `Create API`\n 2. Provide a name and identifier, click `Create`\n 3. On the `Permissions` tab, add a `send:invitation` permission\n\n#### 2. Application\n 1. Click `Applications` -> ` (Test Application)`\n 2. _Optional_: remove `(Test Application)` from the application name, or rename as you see fit\n 3. Add the allowed callback and logout URLs\n - allowed callback URL: `https:///login_callback`\n - allowed logout URL: `https:///login` (yes, that reads `login`)\n - for local testing, `` is `http://localhost:8000`\n - don't forget to click `Save Changes` at the bottom of the page!\n 4. On the `APIs` tab, grant access to the Management API for the `read:users`, `create:users`, and `update:users` permissions\n\n#### 3. Grant your user the `send:invitation` permission\n 1. `Users & Roles` -> `Users` -> `` -> `Permissions` -> `Assign Permissions`\n 2. Select the `send:invitation` permission\n\n### 2. Create your `docker-compose.yml`\nHere's an example of a minimal setup with Docker Compose:\n```yaml\nversion: \"3\"\n\nservices:\n invite0:\n image: eeshugerman/invite0\n ports:\n - 8000:8000 # host:container\n environment:\n INVITE0_DOMAIN: # localhost:8000 for local testing\n ORG_NAME: Your Organization\n SECRET_KEY: \n\n # mail settings are passed directly to Flask-Mail -- see: https://pythonhosted.org/Flask-Mail\n MAIL_SERVER: smtp.gmail.com\n MAIL_PORT: 587\n MAIL_USE_TLS: 1\n MAIL_USERNAME: foo@gmail.com\n MAIL_PASSWORD: passw0rd\n MAIL_SENDER_ADDRESS: foo@gmail.com\n\n # you'll find these values in the settings page for the Application and API created in steps 1 and 2\n AUTH0_CLIENT_ID: \n AUTH0_CLIENT_SECRET: \n AUTH0_DOMAIN: .auth0.com\n AUTH0_AUDIENCE: \n```\n### 3. Run `docker-compose up`\n\n### 4. Log in at `localhost:8000/admin`\n# Configuration\n## Environment variables\nSee available variables and their defaults in [config.py](invite0/config.py).\n\n## Overriding default HTML and CSS\nYou can override the default HTML and CSS with bind-mounts:\n```\nservices:\n invite0:\n volumes:\n - ./signup.html:/invite0/templates/signup.html # just the signup page, or\n - ./templates/:/invite0/templates/ # all HTML including invite email\n - ./styles.css:/invite0/static/css/styles.css\n```\nRefer to the default HTML [here](invite0/templates).\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",1029898659,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},"content_type","creator",8259537,"full_size",59715147,"id",75994625,"images",[101],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},"architecture","amd64","digest","sha256:7a7ea1709b15671d4ff5c082473d2418169ced9b6e40025c5aee8cb71372c244","features","","last_pulled","2026-10-06T02:51:58.853103254Z","last_pushed","2021-07-09T02:53:20Z","os","linux","os_features","os_version","size","variant","2021-07-09T02:56:59.063516Z","last_updater","last_updater_username","media_type","latest","repository",8002677,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":142,"_149":150,"_136":159,"_160":11},{"_40":143,"_42":144,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":145,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":146,"_79":11,"_80":148,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":147},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_151":64,"_152":-5,"_153":-5,"_154":155},"count","next","previous","results",[156],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":157,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},[158],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},[],"canDeleteTags","actionData","errors"]

eeshugerman/invite0

Tags for eeshugerman/invite0