Etebase: Difference between revisions

From NixOS Wiki
Added Caddy example, variable comment refactors/additions
m Modified Caddy example values to reflect Nginx example
 
Line 56: Line 56:
   settings = {
   settings = {
     allowed_hosts = {
     allowed_hosts = {
       allowed_host2 = "etebase.neonpastel.net";
       allowed_host2 = "etebase.your.domain";
       allowed_host1 = "127.0.0.1";
       allowed_host1 = "127.0.0.1";
     };
     };
     global.secret_file = "/home/etebase-server/.etebase";
     global.secret_file = "/path/to/secret";
   };
   };
};
};

Latest revision as of 12:21, 2 September 2024

Etebase is an end-to-end encrypted backend as a service. Think Firebase, but encrypted in a way that only your users can access their data.


Example configurations

Nginx example

This is a basic configuration to run the Etebase server:

  networking.firewall.allowedTCPPorts = [ 443 ];
  services = {
    etebase-server = {
      enable = true;
      unixSocket = "/var/lib/etebase-server/etebase-server.sock"; 
      user = "etebase-server";
      settings = {
        global.debug = false;
        global.secret_file = "/path/to/secret";
        allowed_hosts.allowed_host1 = "etebase.your.domain";
      };
    };
    nginx = {
      enable = true;
      recommendedOptimisation = true;
      recommendedProxySettings = true;
      recommendedTlsSettings = true;
      recommendedGzipSettings = true;
      virtualHosts."etebase.your.domain" = {
        enableACME = true;
        forceSSL = true;
        locations."/".proxyPass = "http://unix:/var/lib/etebase-server/etebase-server.sock";
      };
    };
  };

Caddy example

services.caddy = {
  enable = true;
  virtualHosts = {
    "etebase.your.domain".extraConfig = ''
      reverse_proxy 127.0.0.1:8001 {
        header_up Host {upstream_hostport}
      }
    '';
  };
};

services.etebase-server = {
  enable = true;
  settings = {
    allowed_hosts = {
      allowed_host2 = "etebase.your.domain";
      allowed_host1 = "127.0.0.1";
    };
    global.secret_file = "/path/to/secret";
  };
};

Admin user

To use the Etebase server, the creation of an admin account is required. This requires manual intervention:

CLI Method

Note: This method possibly might only when using the NixOS service. If this command fails, use the INI Method described below
sudo etebase-server createsuperuser

INI Method

First you need to find where the generated .ini configuration file is located:

ls /nix/store | grep etebase-server.ini


As a super user, run this command: ETEBASE_EASY_CONFIG_PATH=/path/to/etebase-server.ini etebase-server createsuperuser and that should prompt you to create a user.

After

Login with these credentials to https://etebase.your.domain/admin and create users for your etebase clients through the GUI.

See also