Passky Server Configurator

This intuitive tool guides you through a series of simple questions to gather the necessary information for your Passky server setup. Once you've provided the details, the configurator generates a custom .env file tailored to your specifications. Simply upload this file to your server, and you're ready to go.

Server Settings

Settings for the server where Passky Server is deployed.

Specifies the number of virtual CPUs allocated to the server. This setting helps calculate CPU usage. If you are unsure of the appropriate number, use 1 as a default value.

This field is used to indicate the country where the server is located. It is primarily for public information, allowing users to choose servers that are geographically closest to them or to select servers in a specific country for data residency preferences.

Admin Panel Settings

Settings related to Admin Panel.

Enter the username for accessing the Admin Panel. This username is required to log in and manage administrative settings and functions.

Enter a secure password for accessing the Admin Panel. This password protects administrative functions and settings, so choose a strong, unique password to ensure the security of your system.

    1. Insert your Yubikey into the computer
    2. Click on Input
    3. Press the gold button located on your Yubikey

    Enter the Site Key provided by Cloudflare Turnstile. This key is used to integrate the captcha service into your site and display the captcha widget to users.

    Enter the Secret Key provided by Cloudflare Turnstile. This key is used for server-side verification of captcha responses to ensure they are valid and secure.

    If you want to self-host YubiCloud you can change this URL to your own.

    You can use our ID, or create your own here.

    Account Settings

    Settings related to accounts.

    Specify the maximum number of accounts that can be created on this Passky server. Enter a numerical value to set a limit, or use -1 for unlimited accounts.

    Specify the maximum number of passwords that each account can store. Enter a numerical value to set a limit, or use -1 for unlimited passwords. This limit will apply to all newly created accounts. Note that you can still change this value for individual accounts within the Admin Panel.

    Specify the maximum number of passwords that each premium account can store. Enter a numerical value to set a limit, or use -1 for unlimited passwords. This limit will apply to all accounts upgraded to premium status. In the Admin Panel, license keys can be generated and, when used by users, this limit will then apply to their accounts.

    Database Settings

    Settings related to a database.

    Database Type *

    Choose the type of database for your Passky server.

    Select SQLite if you are unsure how to self-host a MySQL database or if you are setting up a small instance. SQLite is a lightweight, file-based database that is easy to manage.

    • No Cache: Disables caching. Data is retrieved directly from the database without using a cache.
    • Estimated Row Count: Retrieves an estimated number of rows. Provides faster performance with less accuracy.
    • Daily Accurate Row Count: Retrieves an accurate row count, but this is calculated only once per day. The same value is returned throughout the day.
    • Daily Estimated Row Count: Retrieves an estimated row count, calculated once per day. The same value is returned throughout the day for better performance with reasonable accuracy.

    Enter the name of the SQLite file (without the extension) that will be used to store your data.

    Cache Settings

    Settings related to cache.

    Cache Type *

    Choose the type of cache for your Passky server.

    Configure internal Redis cache for your Passky server. This option is suitable for most deployments, providing efficient caching within the server.

    Configure the external Redis cache for high availability deployments with multiple Passky servers. This option is recommended for advanced setups requiring distributed caching. If you do not plan to use an external Redis instance, use the same configuration as the internal Redis cache.

    Email Settings

    Settings related to email.

    Email Sending Method *

    Choose the method of sending emails for your Passky server.

    API Settings

    Settings related to API endpoints.

    Toggle API endpoints *

    Some API endpoints are optional and primarily intended for statistics.

    Enables or disables the getReport API endpoint, which returns daily statistics on the number of new registrations. This data helps track user growth and registration trends over time.

    Enables or disables the getStats API endpoint, which provides information on server resource consumption, including CPU, memory, and disk usage. This endpoint helps monitor server performance and resource utilization.

    Enables or disables the getInfo API endpoint, which returns detailed project information, including the project version, total number of accounts, storage capacity for accounts and passwords, server location, and hashing cost. This endpoint provides comprehensive insights into the server's configuration and project status.

    Toggle Features *

    Toggle features related to API endpoints.

    Enables or disables the API Rate Limiter, which helps mitigate brute force attacks by limiting the number of requests a user can make in a specified time period. It is recommended to enable this feature to enhance the security and stability of your server.

    Configure the rate limiter for various API endpoints. Enter the rate limit values in seconds. A value of -1 means that no rate limiting will be applied to the respective API endpoint. It is recommended to enable the rate limiter to enhance security and mitigate brute force attacks.