Deze pagina is alleen beschikbaar in het Engels.
Back to FAQ

Run your own Notefox sync server

You can host the Notefox sync service on your own server. This requires a PHP-enabled web server, a MySQL or MariaDB database, and a copy of the Notefox API files.

1. Create a database

Create an empty database in your hosting control panel, phpMyAdmin, or with your MySQL client. Create a database user with full access to that database, then keep its host name, database name, user name, and password ready for the next step.

2. Create the Notefox tables

Open the new database in phpMyAdmin, choose Import, and select the SQL file below. It creates the tables used by the sync API: users, logins, tokens, data, sav_data_current, user_keys, and rate_limits. It also includes the optional error-log and telemetry tables.

Download the Notefox database tables

If you use a command-line client instead, import the same file with mysql -u YOUR_USER -p YOUR_DATABASE < notefox-tables.sql.

3. Configure the API

Copy include/credentials-sample.php to include/credentials.php on your server. Enter the database connection details and set the table variables to the table names created by the import: data, logins, users, and tokens. Do not publish credentials.php or commit it to a repository.

4. Upload and connect

Upload the Notefox API files to your web server, keeping the api/ and include/ directories in the same document root. Make sure PHP can use the mysqli and OpenSSL extensions. Then enter your server's API URL in the Notefox extension settings.

Important

Use HTTPS and a strong database password. The server stores encrypted note data, but it still handles account information and authentication tokens. Keep the API and its database private, backed up, and updated with the Notefox version used by your extension.