Etebase - Revision history

Klinger: Category:Django

2025-03-20T15:45:26Z

← Older revision		Revision as of 15:45, 20 March 2025
Line 91:		Line 91:

	[[Category:Server]]		[[Category:Server]]
			[[Category:Django]]

Denperidge: Modified Caddy example values to reflect Nginx example

2024-09-02T12:21:30Z

Modified Caddy example values to reflect Nginx example

← Older revision		Revision as of 12:21, 2 September 2024
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";
	};		};
	};		};

Denperidge: Added Caddy example, variable comment refactors/additions

2024-09-02T12:18:14Z

Added Caddy example, variable comment refactors/additions

@@ Line 1: / Line 1: @@
 [https://www.etebase.com/ {{PAGENAME}}] 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.
 This is a basic configuration to run the Etebase server:
@@ Line 12: / Line 20: @@
        settings = {
          global.debug = false;
-         global.secret_file = "/path/to/secret"; # Needs to be a non-existing filepath, which is writeable by configured user
+         global.secret_file = "/path/to/secret";
          allowed_hosts.allowed_host1 = "etebase.your.domain";
        };
@@ Line 31: / Line 39: @@
 </syntaxhighlight>
-For the server to accept requests from a remote machine {{ic| allowed_host1}} variable should be set as the server's subdomain/domain name and your proxy has to present a  {{ic| Host}} header.
+=== Caddy example ===
-The django [https://docs.djangoproject.com/en/dev/ref/settings/#std:setting-SECRET_KEY secret key] is preferably a randomly generated key, the use of a secret managing scheme might prove useful. see [[Comparison_of_secret_managing_schemes]].
+services.etebase-server = {
 == Admin user ==

Denperidge: Added CLI Method, changed global.secret_file comment, fixed NixOS syntax highlighting

2024-09-02T10:22:42Z

Added CLI Method, changed global.secret_file comment, fixed NixOS syntax highlighting

← Older revision		Revision as of 10:22, 2 September 2024
Line 3:		Line 3:
	This is a basic configuration to run the Etebase server:		This is a basic configuration to run the Etebase server:

	<~~syntaxHighlight~~ lang=~~nix~~>		<syntaxhighlight lang="nixos">
	networking.firewall.allowedTCPPorts = [ 443 ];		networking.firewall.allowedTCPPorts = [ 443 ];
	services = {		services = {
Line 12:		Line 12:
	settings = {		settings = {
	global.debug = false;		global.debug = false;
	global.secret_file = "/path/to/secret"; # ~~mind permissions~~		global.secret_file = "/path/to/secret"; # Needs to be a non-existing filepath, which is writeable by configured user
	allowed_hosts.allowed_host1 = "etebase.your.domain";		allowed_hosts.allowed_host1 = "etebase.your.domain";
	};		};
Line 29:		Line 29:
	};		};
	};		};
	</~~syntaxHighlight~~>		</syntaxhighlight>

	For the server to accept requests from a remote machine {{ic\| allowed_host1}} variable should be set as the server's subdomain/domain name and your proxy has to present a {{ic\| Host}} header.		For the server to accept requests from a remote machine {{ic\| allowed_host1}} variable should be set as the server's subdomain/domain name and your proxy has to present a {{ic\| Host}} header.
Line 39:		Line 39:
	To use the Etebase server, the creation of an admin account is required. This requires manual intervention:		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}}
			<syntaxhighlight lang="bash">
			sudo etebase-server createsuperuser
			</syntaxhighlight>

			==== INI Method ====
	First you need to find where the generated {{ic\|.ini}} configuration file is located:		First you need to find where the generated {{ic\|.ini}} configuration file is located:
	<syntaxHighlight lang=sh>		<syntaxHighlight lang=sh>
Line 47:		Line 54:
	As a super user, run this command: <code>ETEBASE_EASY_CONFIG_PATH=/path/to/etebase-server.ini etebase-server createsuperuser</code> and that should prompt you to create a user.		As a super user, run this command: <code>ETEBASE_EASY_CONFIG_PATH=/path/to/etebase-server.ini etebase-server createsuperuser</code> 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.		Login with these credentials to https://etebase.your.domain/admin and create users for your etebase clients through the GUI.

Klinger: Category:Server

2024-04-24T21:14:42Z

Category:Server

← Older revision		Revision as of 21:14, 24 April 2024
Line 51:		Line 51:
	== See also ==		== See also ==
	* https://github.com/etesync/server#usage		* https://github.com/etesync/server#usage


			[[Category:Server]]

imported>Ngasull: Fix config env variable as per https://github.com/etesync/server/blob/e9de8f1adb16b47becf700100333c38b8e860f5c/etebase_server/settings.py#L145

2024-01-07T13:02:32Z

Fix config env variable as per https://github.com/etesync/server/blob/e9de8f1adb16b47becf700100333c38b8e860f5c/etebase_server/settings.py#L145

← Older revision		Revision as of 13:02, 7 January 2024
Line 45:		Line 45:


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

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

imported>Underknowledge: Working config with reverse proxy plus minor comments

2023-12-09T21:32:04Z

Working config with reverse proxy plus minor comments

← Older revision		Revision as of 21:32, 9 December 2023
Line 4:		Line 4:

	<syntaxHighlight lang=nix>		<syntaxHighlight lang=nix>
	services = {		networking.firewall.allowedTCPPorts = [ 443 ];
			services = {
	etebase-server = {		etebase-server = {
	enable = true;		enable = true;
	~~port~~ = ~~8001~~;		unixSocket = "/var/lib/etebase-server/etebase-server.sock";
			user = "etebase-server";
	settings = {		settings = {
	global.secret_file = /path/to/secret;		global.debug = false;
	allowed_hosts.allowed_host1 = "~~http://~~etebase.your.domain/";		global.secret_file = "/path/to/secret"; # mind permissions
			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";
			};
			};
			};
	</syntaxHighlight>		</syntaxHighlight>

	For the server to accept requests from a remote machine {{ic\| allowed_host1}} variable should be set as the server's subdomain/domain name.		For the server to accept requests from a remote machine {{ic\| allowed_host1}} variable should be set as the server's subdomain/domain name and your proxy has to present a {{ic\| Host}} header.

	The django [https://docs.djangoproject.com/en/dev/ref/settings/#std:setting-SECRET_KEY secret key] is preferably a randomly generated key, the use of a secret managing scheme might prove useful. see [[Comparison_of_secret_managing_schemes]].		The django [https://docs.djangoproject.com/en/dev/ref/settings/#std:setting-SECRET_KEY secret key] is preferably a randomly generated key, the use of a secret managing scheme might prove useful. see [[Comparison_of_secret_managing_schemes]].
Line 31:		Line 47:
	As a super user, run this command: <code>ETEBASE_EASY_CONFIG_INI=/path/to/etebase-server.ini etebase-server createsuperuser</code> and that should prompt you to create a user.		As a super user, run this command: <code>ETEBASE_EASY_CONFIG_INI=/path/to/etebase-server.ini etebase-server createsuperuser</code> and that should prompt you to create a user.

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

	== See also ==		== See also ==
	* https://github.com/etesync/server#usage		* https://github.com/etesync/server#usage

imported>Reeseovine: typo in example URL

2023-10-19T18:12:45Z

typo in example URL

← Older revision		Revision as of 18:12, 19 October 2023
Line 10:		Line 10:
	settings = {		settings = {
	global.secret_file = /path/to/secret;		global.secret_file = /path/to/secret;
	allowed_hosts.allowed_host1 = "http:/etebase./your.domain/";		allowed_hosts.allowed_host1 = "http://etebase.your.domain/";
	};		};
	};		};

imported>Aktaboot at 21:24, 17 June 2023

2023-06-17T21:24:00Z

← Older revision		Revision as of 21:24, 17 June 2023
Line 19:		Line 19:
	The django [https://docs.djangoproject.com/en/dev/ref/settings/#std:setting-SECRET_KEY secret key] is preferably a randomly generated key, the use of a secret managing scheme might prove useful. see [[Comparison_of_secret_managing_schemes]].		The django [https://docs.djangoproject.com/en/dev/ref/settings/#std:setting-SECRET_KEY secret key] is preferably a randomly generated key, the use of a secret managing scheme might prove useful. see [[Comparison_of_secret_managing_schemes]].

	== ~~User Creation~~ ==		== Admin user ==

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

imported>Aktaboot: Created page with "[https://www.etebase.com/ {{PAGENAME}}] 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. Th..."

2023-06-17T21:22:39Z

Created page with "[https://www.etebase.com/ {{PAGENAME}}] 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. Th..."

New page

[https://www.etebase.com/ {{PAGENAME}}] 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.

This is a basic configuration to run the Etebase server:

<syntaxHighlight lang=nix>
services = {
etebase-server = {
enable = true;
port = 8001;
settings = {
global.secret_file = /path/to/secret;
allowed_hosts.allowed_host1 = "http:/etebase./your.domain/";
};
};
</syntaxHighlight>

For the server to accept requests from a remote machine {{ic| allowed_host1}} variable should be set as the server's subdomain/domain name.

The django [https://docs.djangoproject.com/en/dev/ref/settings/#std:setting-SECRET_KEY secret key] is preferably a randomly generated key, the use of a secret managing scheme might prove useful. see [[Comparison_of_secret_managing_schemes]].

== User Creation ==

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

First you need to find where the generated {{ic|.ini}} configuration file is located:
<syntaxHighlight lang=sh>
ls /nix/store | grep etebase-server.ini
</syntaxHighlight>

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

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

== See also ==
* https://github.com/etesync/server#usage