VigiloAuth Admin-UI

---

🧠 VigiloAuth Admin UI is the frontend interface for managing users, roles, clients, and configurations in the VigiloAuth server.

⚠️ The VigiloAuth Admin-UI is is under active development. You can expect rapid iterations and new features.

License: Apache This server is free and open source, developed for community use and OIDF certification.

💬 Join the Conversation: We're gathering feedback and ideas in the discussion threads. Come share your thoughts!

---

Table of Contents

• VigiloAuth Admin-UI
  • Table of Contents
  • 1. Introduction
  • 2. Features
  • 3. Getting Started
    • 3.1. Pull the Docker Image
    • 3.2. Run the Container
  • 4. Contributing
    • 4.1. How to Contribute
    • 4.2. Commit Standards
    • 4.3. Commit Types
  • 5. License

---

1. Introduction

This is the web-based Admin UI for managing the VigiloAuth server. Built with modern frontend frameworks (e.g., React + Vite), it provides secure access to administrative functionality such as:

• Managing registered clients
• Viewing and deleting users
• Issuing tokens
• Configuring realms and identity providers (future)

---

2. Features

• 🔐 Login with JWT via the VigiloAuth backend
• 👤 Role-based admin interface
• 📋 Manage users and clients
• ⚙️ Plug-and-play with any VigiloAuth instance
• 🎨 Responsive and modern UI

---

3. Getting Started

You can easily run the VigiloAuth Admin-UI using Docker.

3.1. Pull the Docker Image

docker pull vigiloauth/ui:latest

3.2. Run the Container

docker run -d -p 3000:3000 vigiloauth/ui:latest

This will start the UI on http://localhost:3000 by default.

🛠️ Note: The UI expects a backend instance of VigiloAuth to be available and configured. Make sure you’ve started the backend server and updated the appropriate environment variables or configuration.

---

4. Contributing

We welcome contributions to improve VigiloAuth! Follow the steps below to ensure a smooth contribution process.

If you're a first-time contributor, check out our Good First Issues.

4.1. Reporting Security Vulnerabilities

If you have found a security vulnerability, please follow our instructions on how to properly report it.

4.2. How to Contribute

1. Fork the Repository: Create your own fork on GitHub.
2. Clone Your Fork: Clone it to your local development environment.
3. Create a Branch: Create a new branch from master (e.g., feature/my-feature).
4. Make Your Changes: Implement your changes in alignment with project goals.
5. Write Tests: Add or update tests to cover your changes.
6. Commit Your Changes: Use Conventional Commits (see below).
7. Push Your Changes: Push your branch to your GitHub fork.
8. Open a Pull Request: Submit a PR to the main repository and clearly describe your changes.

4.3. Commit Standards

We follow the Conventional Commit standards to ensure clear and meaningful commit messages. Use the format:

<type>[optional scope]: <description>
[optional body]
[optional footer(s)]

4.4. Commit Types

• breaking: Introduce a breaking change that may require users to modify their code or dependencies.
• feat: Add a new feature that enhances the functionality of the project.
• fix: Apply a bug fix that resolves an issue without affecting functionality.
• task: Add or modify internal functionality that supports the codebase but doesn't introduce a new feature or fix a bug (e.g., utility methods, service logic, or internal improvements).
• docs: Update documentation, such as fixing typos or adding new information.
• style: Changes that don’t affect the code’s behavior, like formatting or code style adjustments.
• refactor: Refactor code without adding features or fixing bugs.
• test: Add or modify tests.
• chore: Miscellaneous changes like updates to build tools or dependencies.

For more information about contributing, please read our contribution guide

---

5. License

Copyright 2024 Olivier Pimparé-Charbonneau

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.