OIBDeployer
OIBDeployer copied to clipboard
OIB Deployer - Setup Guide
This document outlines the setup requirements for running OIB Deployer either locally or through self-hosting via GitHub Pages.
Prerequisites
- Microsoft Entra ID (Azure AD) tenant with administrative access
- Microsoft Intune license
- Node.js 18+ and npm
Azure App Registration Setup
Before running the application, you must create an Entra ID App Registration:
- Navigate to Entra Portal → App registrations
- Click New registration
- Configure the registration:
- Name:
OIB Deployer(or your preferred name) - Supported account types: Accounts in this organizational directory only
- Redirect URI:
- For local development:
http://localhost:5173 - For GitHub Pages:
https://yourusername.github.io/your-repo-nameor your custom domain
- For local development:
- Name:
- Click Register
- Note the Application (client) ID - you'll need this for configuration
- Under API permissions, add:
- Microsoft Graph:
DeviceManagementConfiguration.ReadWrite.All(Delegated permission) - (Optional) Grant admin consent for your organization
- Microsoft Graph:
- Under Authentication → Implicit grant and hybrid flows:
- Enable Access tokens
- Enable ID tokens
Local Development Setup
1. Clone and Install Dependencies
git clone https://github.com/yourusername/OIBDeployer.git
cd OIBDeployer
npm install
2. Environment Configuration
Create a .env.local file in the project root:
VITE_CLIENT_ID=your-app-registration-client-id-here
Replace your-app-registration-client-id-here with the Application (client) ID from your Entra ID App Registration.
3. Run Development Server
npm run dev
The application will be available at http://localhost:5173
Self-Hosting Setup (GitHub Pages)
1. Fork the Repository
Fork this repository to your GitHub account.
2. Configure GitHub Repository Variables
In your forked repository:
- Go to Settings → Secrets and variables → Actions
- Click the Variables tab
- Add a new repository variable:
- Name:
VITE_CLIENT_ID - Value: Your Entra ID App Registration Application (client) ID
- Name:
3. Update Entra ID App Registration Redirect URI
Update your Entra ID App Registration redirect URI to match your deployment URL:
- GitHub Pages:
https://yourusername.github.io/repository-name - Custom domain:
https://your-custom-domain.com
4. Enable GitHub Pages
- Go to repository Settings → Pages
- Under Source, select GitHub Actions
- The deployment workflow will automatically trigger on pushes to the main branch
5. Custom Domain (Optional)
If using a custom domain:
- Add a
CNAMEfile to thepublicfolder with your domain name - Configure DNS to point to GitHub Pages
- Update the Entra ID App Registration redirect URI accordingly
Build for Production
npm run build
The built files will be in the dist directory.
Environment Variables Reference
| Variable | Description | Required |
|---|---|---|
VITE_CLIENT_ID |
Entra ID App Registration Application (client) ID | Yes |