WriteFreely - Revision history

Klinger: Category:Web Applications

2025-12-29T18:35:25Z

← Older revision		Revision as of 18:35, 29 December 2025
Line 184:		Line 184:
	[[Category:ActivityPub]]		[[Category:ActivityPub]]
	[[Category:Server]]		[[Category:Server]]
			[[Category:Web Applications]]

Pigs: link to other wiki entries

2025-06-01T06:17:14Z

link to other wiki entries

← Older revision		Revision as of 06:17, 1 June 2025
Line 71:		Line 71:
	==== MySQL ====		==== MySQL ====

	You can choose to use a MySQL database instead of SQLite.		You can choose to use a [[Mysql\|MySQL]] database instead of SQLite.

	{{Note\|WriteFreely requires a database password to be configured. See [https://github.com/writefreely/writefreely/issues/568 writefreely/writefreely#568] for details.}}		{{Note\|WriteFreely requires a database password to be configured. See [https://github.com/writefreely/writefreely/issues/568 writefreely/writefreely#568] for details.}}
Line 129:		Line 129:
	=== Nginx ===		=== Nginx ===

	Nginx can be used as a reverse proxy for your WriteFreely instance. This can be configured with the options under {{nixos:option\|services.writefreely.nginx}}.		[[Nginx]] can be used as a reverse proxy for your WriteFreely instance. This can be configured with the options under {{nixos:option\|services.writefreely.nginx}}.

	<syntaxHighlight lang="nix">		<syntaxHighlight lang="nix">
Line 149:		Line 149:
	=== ACME ===		=== ACME ===

	Automatic SSL certificates can be retrieved using ACME. When used with Nginx, the certificates will be managed by NixOS's default ACME configuration. When '''not''' using Nginx, WriteFreely will manage certificates itself.		Automatic SSL certificates can be retrieved using [[ACME]]. When used with Nginx, the certificates will be managed by NixOS's default ACME configuration. When '''not''' using Nginx, WriteFreely will manage certificates itself.

	<syntaxHighlight lang="nix">		<syntaxHighlight lang="nix">

Klinger: added Category:ActivityPub

2024-05-16T19:28:26Z

added Category:ActivityPub

← Older revision		Revision as of 19:28, 16 May 2024
Line 182:		Line 182:
	</syntaxHighlight>		</syntaxHighlight>

			[[Category:ActivityPub]]
	[[Category:Server]]		[[Category:Server]]

Klinger: Category:Server

2024-04-19T18:03:59Z

Category:Server

← Older revision		Revision as of 18:03, 19 April 2024
Line 181:		Line 181:
	}		}
	</syntaxHighlight>		</syntaxHighlight>

			[[Category:Server]]

imported>Jakehamilton: Remove "Evaluate" tip

2023-01-26T05:34:29Z

Remove "Evaluate" tip

← Older revision		Revision as of 05:34, 26 January 2023
Line 4:		Line 4:

	To create your WriteFreely instance, enable the option {{nixos:option\|services.writefreely.enable}}.		To create your WriteFreely instance, enable the option {{nixos:option\|services.writefreely.enable}}.

	~~{{Evaluate}}~~

	<syntaxHighlight lang="nix">		<syntaxHighlight lang="nix">

imported>Jakehamilton at 23:57, 21 January 2023

2023-01-21T23:57:18Z

← Older revision		Revision as of 23:57, 21 January 2023
Line 32:		Line 32:
	services.writefreely = {		services.writefreely = {
	enable = true;		enable = true;

	admin = {		admin = {
	name = "my-username";		name = "my-username";

imported>Jakehamilton: An open source platform for building a writing space on the web.

2023-01-21T23:41:57Z

An open source platform for building a writing space on the web.

New page

[https://writefreely.org/ WriteFreely] is a blogging platform with support for ActivityPub and is available in NixOS starting with release 22.11.

== Setup ==

To create your WriteFreely instance, enable the option {{nixos:option|services.writefreely.enable}}.

{{Evaluate}}

<syntaxHighlight lang="nix">
{
services.writefreely = {
# Create a WriteFreely instance.
enable = true;

# Create a WriteFreely admin account.
admin.name = "my-username";

# The public host name to serve.
host = "blog.example.com";
};
}
</syntaxHighlight>

For more specific configuration, see the following sections.

=== Admin Account ===

WriteFreely requires an admin account be created to access the web UI. This can be set using the options under {{nixos:option|services.writefreely.admin}}.

<syntaxHighlight lang="nix">
{
services.writefreely = {
enable = true;
admin = {
name = "my-username";
# If not specified, a default password of "nixos" will be used. Your password can be
# updated using the web interface.
initialPasswordFile = "/path/to/password.txt";
};
};
}
</syntaxHighlight>

=== Database ===

WriteFreely supports multiple database engines. The NixOS module lets you select which you would like to use and enables easy provisioning of local databases. See the options under {{nixos:option|services.writefreely.database}}.

==== SQLite ====

The default database is SQLite. This can be configured with the following options.

<syntaxHighlight lang="nix">
{
services.writefreely = {
enable = true;

database = {
# This is the default database type.
type = "sqlite3";

# This is the file name of the SQLite database, relative to the
# stateDir (default: /var/lib/writefreely).
filename = "writefreely.db";

# The name of the database to create in SQLite.
database = "writefreely";
};
};
}
</syntaxHighlight>

==== MySQL ====

You can choose to use a MySQL database instead of SQLite.

{{Note|WriteFreely requires a database password to be configured. See [https://github.com/writefreely/writefreely/issues/568 writefreely/writefreely#568] for details.}}

===== Local MySQL =====

To create a local MySQL database, see the following example.

<syntaxHighlight lang="nix">
{
services.writefreely = {
enable = true;

database = {
# Use the MySQL database engine.
type = "mysql";

# Run MySQL locally.
createLocally = true;

# Set a password for the database so WriteFreely can access it.
passwordFile = "/path/to/password.txt";
};
};
}
</syntaxHighlight>

===== Remote MySQL =====

To use a remote MySQL database, see the following example.

<syntaxHighlight lang="nix">
{
services.writefreely = {
enable = true;

database = {
# Use the MySQL database engine.
type = "mysql";

# The name of the database to store data in.
name = "writefreely";
# The database user to connect as.
user = "writefreely";
# The database host to connect to.
host = "10.0.0.1";
# The port to connect to the database on.
port = 3306;

# Set a password for the database so WriteFreely can access it.
passwordFile = "/path/to/password.txt";
};
};
}
</syntaxHighlight>

=== Nginx ===

Nginx can be used as a reverse proxy for your WriteFreely instance. This can be configured with the options under {{nixos:option|services.writefreely.nginx}}.

<syntaxHighlight lang="nix">
{
services.writefreely = {
enable = true;

nginx = {
# Enable Nginx and configure it to serve WriteFreely.
enable = true;

# You can force users to connect with HTTPS.
forceSSL = true;
};
};
}
</syntaxHighlight>

=== ACME ===

Automatic SSL certificates can be retrieved using ACME. When used with Nginx, the certificates will be managed by NixOS's default ACME configuration. When '''not''' using Nginx, WriteFreely will manage certificates itself.

<syntaxHighlight lang="nix">
{
services.writefreely = {
enable = true;

acme = {
# Automatically fetch and configure SSL certs.
enable = true;
};
};
}
</syntaxHighlight>

=== Settings ===

Settings for WriteFreely's configuration file <code>config.ini</code> can be set using the option {{nixos:option|services.writefreely.settings}}. See the [https://writefreely.org/docs/latest/admin/config WriteFreely documentation] for a list of settings.

<syntaxHighlight lang="nix">
{
services.writefreely = {
enable = true;

settings = {
server = {
port = 8080;
};
};
};
}
</syntaxHighlight>