aria/FMHY-Website
1
0
Fork 0
mirror of https://github.com/fmhy/edit.git synced 2025-08-03 09:42:14 +10:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update

Browse source
This commit is contained in:
Hugo 2025-07-05 17:56:30 +01:00
parent c934bf07eb
commit a424f8c3be
2 changed files with 73 additions and 123 deletions
Download patch file Download diff file Expand all files Collapse all files

28
docs/other/selfhosting.md
View file

@ -5,22 +5,17 @@ description: This guide will help you set up and run your own instance of FMHY l
# Selfhosting
This guide will help you set up and run your own instance of FMHY locally.
:::warning
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
This guide will help you set up and run your own instance of FMHY locally.
### Docker (Experimental)
You will need to install Docker and Docker Compose run your own instance of FMHY locally.
To run a local instance, you will need to install [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/).
- [Docker](https://docs.docker.com/get-docker/)
- [Docker Compose](https://docs.docker.com/compose/install/)
After installing Docker and Docker Compose, run the following commands:
After installing both, run the following commands:
```bash
git clone https://github.com/fmhy/edit.git
@ -28,13 +23,24 @@ cd edit
sudo docker compose up --build
```
It should take a few minutes to build the image and start the container, running at port 4173.
It might take a few minutes to build the image and start the container, running at port 4173.
### Nix Flake
You can use [nix](https://nixos.org/) to set up a development environment, we have a [flake](https://nixos.wiki/wiki/Flakes) that setups `nodejs` and `pnpm`.
1. Fork the repository and clone it to your local machine with `git clone https://github.com/fmhy/edit.git`.
2. Run `nix flake update` to update the flake lock file.
3. Run `nix develop` to enter the development environment.
4. Make your changes.
5. Exit the development environment by running `exit`.
### Manually
You will need to install the following:
- [Git](https://git-scm.com/downloads)
- [Node.js](https://nodejs.org/en/download/) - Use the latest available LTS, doesn't matter much
- [pnpm 9.12.2 or newer](https://pnpm.io/installation)
- [Node.js](https://nodejs.org/en/download/) - Use latest available LTS release.
- [pnpm 9.12.2+](https://pnpm.io/installation)
#### Step 1: Clone the Repository