Selfhosting

This guide will help you set up and run your own instance of FMHY locally.

Do note that you must differentiate your instance from the official site (fmhy.net) to avoid confusion. Steps to do so are given below.

Prerequisites

• Git
• Node.js - Use the latest available LTS, doesn’t matter much
• pnpm 9.12.2 or newer

Step 1: Clone the Repository

git clone <https://github.com/fmhy/edit.git>
cd edit

Step 2: Install Dependencies

Install project dependencies using pnpm:

pnpm install

Step 3: Development Mode

To run the project in development mode:

# Start the documentation site in dev modepnpm docs:dev
# Start the API in dev mode (if needed)pnpm api:dev

The development server will start at http://localhost:5173 by default.

Step 4: Building for Production

You will need to update:

• the meta constant in docs/.vitepress/constants.ts
• name: Name of your instance
• hostname: Your domain
• description: Description of your instance
• tags: Opengraph tags
• build: Build options (can be configured with Environment Variables)
• docs/index.md
• title
• description
• hero.name
• hero.tagline

To build the project for production:

# Build the documentation sitepnpm docs:build
# Build the API (if needed) using the Node.js presetNITRO_PRESET=node pnpm api:build