typress
An editorial workshop.日本語

Install

To publish a site, you install typress on a server connected to the internet. Paste one command into the server, answer a few questions, and you're done.

What you need

  • A server: think of it as your own computer that you rent on the internet. Providers such as DigitalOcean, Vultr and Hetzner rent them as a "VPS" for a few dollars a month. Choose Ubuntu as the operating system. Plans marked "ARM" aren't supported yet.
  • A domain (optional): your site's address, like blog.example.com. You can buy one from a registrar such as Namecheap. Without one, you can start with your server's number (its IP address).

1. Point your domain at the server (if you have one)

In your registrar's dashboard, open the DNS settings and add an "A record" with your server's IP address. It can take minutes to hours to take effect. Skip this if you're not using a domain.

2. Connect to the server

Open Terminal on a Mac (or PowerShell on Windows) and connect with the user name and IP address your provider gave you:

ssh username@your-server-ip

3. Paste this line and press Enter

curl -fsSL https://typress.miazakura.dev/install.sh | sudo sh

If it asks for a password, type your server password. Nothing shows on screen while you type; that's normal.

4. Answer the questions

Use the arrow keys and Enter, or type and press Enter.

  • Site address: use a domain or the IP address
  • Admin email: you'll sign in with it
  • Admin password: 12 characters or more, entered twice
  • Reminder emails: whether to get an email when your site's padlock (https) is close to expiring

It then lists what it's about to do; press Enter to go ahead. It takes a few minutes. To stop at any point, press Ctrl and C together.

What the installer takes care of

  • Downloads typress and checks nobody tampered with it on the way. If anything looks wrong, it stops without installing.
  • Sets up the padlock (https) for your site.
  • Makes typress start automatically when the server restarts.
  • Creates your admin account.
  • Checks that the site is up.

5. Open the admin

When it says "Done!", open the https://your-domain/admin/ address it shows and sign in with the email and password you chose.

The server now holds a "master key" for your site (in /etc/typress/typress.env). You'll need it if you ever move servers, so keep a copy somewhere safe, such as your own computer.

Next, go to Getting started.

If something goes wrong

See Troubleshooting.