An open-source entry in TopGit's GitHub warehouse: fastlane/boarding, 878 stars, Ruby. Instantly create a simple signup page for TestFlight beta testers
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
boarding is part of fastlane: connect all deployment tools into one streamlined workflow.
What's boarding?
Instantly create a simple signup page for TestFlight beta testers.
Have you ever been to an airport, where you had to ask the manager of the airport if you can board now? Once the manager agrees, you'll be carried from your check-in to your gate into your plane.
Because that's what you do right now as an app developer when you want to add a new tester to your TestFlight app: Open Screenshots
Why don't you have a simple web site you can share with potential testers (e.g. email newsletter, Facebook, Twitter) on which people interested in trying out your new app can just board on their own?
Thanks to spaceship.airforce (oh well, I really talk a lot about flying :rocket:) it is now possible to automate the boarding process for your TestFlight beta testers.
Example
Take a look at this live example page: boarding.herokuapp.com
Like this tool? Be the first to know about updates and new fastlane tools
Getting Started
Assuming you already have a Heroku account follow those steps:
Enter your iTunes Connect credentials and the bundle identifier of your app. This will all be stored on your own Heroku instance as environment variables
Click on View once the setup is complete and start sharing the URL
Assuming you already have an Azure account follow those steps:
Enter your iTunes Connect credentials and the bundle identifier of your app. This will all be stored on your own Heroku instance as environment variables
It can take up to 5 minutes until everything is loaded.
boarding does all kinds of magic for you, like fetching the app name and app icon.
Heroku is free to use for the standard machine. If you need a Heroku account, ask your back-end team if you already have a company account.
If your account is protected using 2-factor author, follow the 2 step verification guide.
Security
To secure your webpage, you only have to set the ITC_TOKEN environment variable to any password.
You can send your users the link and tell them the password
You can send them the direct link including the token like this: https://url.com/?token=[password]
Available environment variables
Required:
ITC_USER iTunes Connect username
ITC_PASSWORD iTunes Connect password
ITC_APP_ID The Apple ID or Bundle Identifier of your app
Optional:
ITC_TOKEN Set a password to protect your website from random people signing up
ITC_CLOSED_TEXT Set this text to temporary disable enrollment of new beta testers
RESTRICTED_DOMAIN Set this domain (in the format domain.com) to restrict users with emails in another domain from signing up. This list supports multiple domains by setting it to a comma delimited list (domain1.com,domain2.com)
FASTLANE_ITC_TEAM_NAME If you're in multiple teams, enter the name of your iTC team here. Make sure it matches.
FASTLANE_SESSION You need to provide a pregenerated session via fastlane spaceauth if you have 2-factor authentication enabled and want to use any actions that communicates with App Store Connect.
IMPRINT_URL If you want a link to an imprint to be shown on the invite page.
Custom Domain
With Heroku you can easily use your own domain, follow this guide.
With Azure you can easily use your own domain, follow this guide.
Alternative Setup Options
Docker image: emcniece/docker-boarding
How does this work?
boarding is part of fastlane, which helps you automate everything you usually do manually as an iOS developer.
Using spaceship.airforce it is possible to manage testers, builds, metadata, certificates and so much more.
This repository is a simple Rails application with most code in these files:
invite_controller.rb
invite/index.html.erb
More information about this automation process can be found here.
Customize
If you want to change the design, layout or even add new features:
Install the Heroku toolbelt and heroku login
Clone your application using heroku git:clone --app [heroku_app_name] (it will be an empty repo)
You may see a message saying warning: You appear to have cloned an empty repository.. If so, just continue on with the instructions. This is a known Heroku issue
cd [heroku_app_name]
git pull https://github.com/fastlane/boarding
Modify the content, in particular the files that are described above.
Test it locally by running ITC_USER="email" ITC_... rails s and opening http://127.0.0.1:3000
Commit the changes
git push
It is recommended to also store your version in your git repo additionally to Heroku.
Update to a new version
From time to time there will be updates to boarding. There are 2 ways to update your Heroku application:
Recommended: Using the terminal
Install the Heroku toolbelt and heroku login
Clone your application using heroku git:clone --app [heroku_app_name] (it will be an empty repo)
cd [heroku_app_name]
git pull https://github.com/fastlane/boarding
git push
Using Heroku website
Delete your application on heroku.com
Create a new boarding application
Enter your user credentials again
Using Azure website
Navigate to the Azure Portal
Login and navigate to your WebApp
On Overview hit the restart button
Managing Azure version
If you installed boarding using the deploy to Azure button, boarding will be deployed in an Azure WebApp for containers.
This means that azure is running the docker-version of boarding.
Setting optional parameters in Azure
In order to set the optional parameters for boarding follow these steps:
Navigate to the Azure Portal
Login and navigate to your WebApp
Under Settings click Application settings
Click the link + Add new setting and add the the optional parameter i.e. ITC_CLOSED_TEXT = We are closed!
Hit Save and navigate to Overview
On Overview hit the restart button
Troubleshoot boarding on Azure
When you run boarding on Azure, it could happen that you run into an HttpStatus 503 showing Service Unavailable
There can be multiple reasons for that:
boarding isn't yet fully loaded. Wait a few minutes hit refresh.
The provided parameters are wrong (ITC_USER, ITC_PASSWORD, ITC_APP_ID). Please go to the settings in Azure and check if they are right.
For further troubleshooting, please got to Azure App Service on Linux FAQ
Like this tool? Be the first to know about updates and new fastlane tools
Special thanks
Special thanks to @lee_moonan for designing the awesome logo.
Development Setup
gem install bundler
bundle install
Create a .env.local file with the following contents:
Help us keep boarding open and inclusive. Please read and follow our Code of Conduct.
License
This project is licensed under the terms of the MIT license. See the LICENSE file.
This project and all fastlane tools are in no way affiliated with Apple Inc. This project is open source under the MIT license, which means you have full access to the source code and can modify it to fit your own needs. All fastlane tools run on your own computer or server, so your credentials or other sensitive information will never leave your own computer. You are responsible for how you use fastlane tools.
The most recent commit recorded on fastlane/boarding was 2.6 years ago, based on the GitHub push timestamp. The repository has 190 forks — one of the better signals of community interest.
How many stars does fastlane/boarding have?
fastlane/boarding has 878 GitHub stars — refresh the page for the live number, or check github.com/fastlane/boarding. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is fastlane/boarding open source?
Yes — fastlane/boarding ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/fastlane/boarding.
What is fastlane/boarding?
fastlane/boarding (fastlane/boarding) is a Ruby project on GitHub. From the project's own README: Instantly create a simple signup page for TestFlight beta testers
What language is fastlane/boarding written in?
fastlane/boarding is written primarily in Ruby. GitHub's language field is based on the largest share of bytes in the default branch.
What license does fastlane/boarding use?
fastlane/boarding is released under the MIT license. Always verify the LICENSE file directly on GitHub for the authoritative terms — license strings can be edited out of sync with a project's actual stance.
Where do I read more about fastlane/boarding?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/fastlane/boarding is the definitive source.
Read full README in the tab above.
Still deciding about boarding?
One click hands the question to an AI along with this page — see what it says about boarding.
/boarding
