Memos

Description

Memos is a privacy-first, lightweight note-taking solution that allows you to effortlessly capture and share your ideas. Experience effortless plain text writing with pain-free, complemented by robust Markdown syntax support for enhanced formatting.

Getting Started

Memos is installed with an image and automatically starts when the server boots up.

After the image installation, the Memos web interface will be accessible at https://example.com/, where example.com is your server’s hostname.

To register an administrator account, please follow this link: https://example.com/. Complete the required fields and click Sign up.

Changing domain

If you wish to use your own domain or subdomain to access the Memos web interface, you will need to log into the server via SSH as the root user and execute the command:

add_domain

You will be prompted to enter a domain or subdomain in the format subdomain.example.com.

note

Make sure that your domain exists and points to the IPv4 address of your server!

Once the command completes, a Let’s Encrypt certificate will be issued for the specified domain or subdomain, and the web interface will become accessible at https://example.com/, where example.com is the previously specified domain (subdomain).

User Management

Disabling User Registration

By default, user registration is open to everyone, which means anyone with access to your instance can create an account. For security and privacy reasons, we strongly recommend disabling user registration, especially if your Memos instance is publicly accessible.

Follow these steps to disable it:

• Open the Settings Panel
  Click on the gear icon in the left sidebar to open the settings menu.

• Go to System Settings
  Under the Admin section, click on System.

• Disable User Registration
  Find the toggle labeled “Disallow user registration”. Switch it on (the toggle should turn blue), which will disable the ability for new users to register.

• Save Your Changes
  Click the “Save” button at the bottom right to apply your changes.

Create a New User

If you've disabled public registration (recommended), you can manually create user accounts via the admin panel.

Steps:

• Open the Settings Panel
  Click the gear icon in the left sidebar to open the settings.

• Navigate to the Member Section
  Under the Admin section, click Member.

• Fill in the User Details
  In the Create a member form:

  • Username — Enter a unique username.
  • Password — Set a secure password.
  • Role — Choose the role.

• Create the User
  Click the Create button to add the new user.

• Verify User in the Member List
  Once created, the user will appear in the Member list below.

Installed Software

Name	License
Memos	MIT license
Caddy	Apache License 2.0

Useful Links

For more information about the installed packages, please refer to their official documentation:

• Memos
• Caddy