Getting Started with WriteFreely about:reader?url=https%3A%2F%2Fsiteproxy.ruqli.workers.dev%3A443%2Fhttps%2Fwritefreely.
org%2Fstart
[Link]
Getting Started with WriteFreely
5-6 minutes
This guide will walk you through setting up your own WriteFreely
instance. It requires technical knowledge and access to a server
you control.
Run into problems along the way? Ask for help on our forum.
Don't need to self-host? The [Link] team provides fully-
managed WriteFreely hosting, which also funds our work on the
project. You can also join an existing community.
Requirements
WriteFreely has minimal requirements to get up and running.
You'll only need:
• The ability to run an executable
• About 30 minutes
Requirements for MySQL-backed installs
• A MySQL (5.6+) database
• Database server timezone set to UTC
Set Up
First, download the latest release for your operating system. If
your OS and system architecture are not listed, you'll need to
build from source, instead.
1 of 6 31-Oct-22, 6:55 AM
Getting Started with WriteFreely about:reader?url=https%3A%2F%[Link]%2Fstart
If you plan to use MySQL for your database, separately connect
to your MySQL server now and run:
CREATE DATABASE writefreely CHARACTER SET latin1
COLLATE latin1_swedish_ci;
Extract the files and go into the project folder. Next, start the
configuration process by running the following command. This
will walk you through the various ways you can configure your
instance:
writefreely config start
Generate the encryption keys for your instance by running:
writefreely keys generate
And finally, run:
writefreely
Running in Production
To run your instance publicly, you can either run WriteFreely as a
standalone server or put it behind a reverse proxy. (Learn the
difference here.)
Standalone server
To configure the application to run as a standalone server, run:
writefreely config start
...and choose Production, standalone for your Environment.
Next, choose whether the site will be Insecure or Secure. If you
choose Secure, you'll need to enter the absolute paths to your
Certificate and Key. With those configured, WriteFreely will serve
2 of 6 31-Oct-22, 6:55 AM
Getting Started with WriteFreely about:reader?url=https%3A%2F%[Link]%2Fstart
traffic on port 80 and 443, redirecting all insecure traffic to your
https:// address.
Behind a reverse proxy
Here's an example nginx configuration. It compresses certain
files, allows federation endpoints on /.well-known/ to co-exist
with other uses (like Let's Encrypt), and serves static files with
nginx instead of the application. Values you should change to
match your own configuration are in bold:
server {
listen 80;
listen [::]:80;
server_name [Link];
gzip on;
gzip_types
application/javascript
application/x-javascript
application/json
application/rss+xml
application/xml
image/svg+xml
image/x-icon
application/[Link]-fontobject
application/font-sfnt
text/css
text/plain;
gzip_min_length 256;
gzip_comp_level 5;
gzip_http_version 1.1;
3 of 6 31-Oct-22, 6:55 AM
