The Admin Dashboard serves as the central hub for managing your workspaces and user-related activities. From here, you can efficiently oversee and control various aspects of your platform.

  • Insights Dashboard: Gain valuable insights into platform usage.
  • Manage Users: Handle user-related actions, such as inviting, elevating admins, and deleting users.
  • Manage Workspaces: Create, edit, and delete workspaces while managing workspace-specific details and user memberships.

Dashboard

The Dashboard section provides an overview of essential metrics and statistics regarding users, workspaces, and activity. This snapshot allows you to track the usage and performance of your platform.

Get insights into your organization’s usage of Hoppscotch.

  • Number of Users: Monitor the count of registered users.
  • Number of Workspaces: Keep track of the total number of workspaces.
  • Number of Requests: Measure the volume of requests made by your organization.
  • Number of Collections: Track the quantity of collections within the platform.

Manage users

The Users section empowers you to effectively control user-related actions. It streamlines the process of user management, making it simple to oversee the user base.

In Hoppscotch community edition, any user can create an account and use the platform.
  • User List: View a comprehensive list of all users on your platform.
  • Invite Users: Send invitations to new users, welcoming them to the platform.
  • Admin Privileges: Elevate users to administrative roles for increased permissions.
  • User Deletion: Delete users when necessary.

Manage Workspaces

In the Manage Workspace section, you can efficiently handle workspace-related operations, ensuring that collaborations and projects run smoothly.

  • Workspace Creation: Establish new workspace tailored to specific projects or departments.
  • Workspace Editing: Modify workspace details and configurations as needed.
  • Workspace Deletion: Disband workspaces that are no longer relevant.
  • User Memberships: View and manage the users associated with each workspace.

Server Settings

In the Server Settings section, you have the ability to both view and edit the environment variables that were configured during the setup of your self-hosted instance.

Configurations

  1. Configure Authentication Providers: Customize authentication providers, including Google, Microsoft, GitHub, and email, directly from the settings page.

  2. Configure SMTP Settings: Set up your SMTP settings for seamless email integration.

  3. Reset Configurations: If needed, reset your configurations back to their original state.

After making any configuration updates, be sure to save the changes. The server will automatically restart to apply the modifications.

Hard Reset Configurations

If you need to perform a hard reset of the server configurations, execute the following command in your terminal to reset all your environment variables:

docker exec -it <db_container_id> psql -d hoppscotch -c "TRUNCATE \"InfraConfig\";"

You can replace <db_container_id> with the actual ID of your Docker container.