mirror of
https://git.numenor-labs.us/dsfx.git
synced 2025-04-29 08:10:34 +00:00
docs(hosting): improve docs
This commit is contained in:
parent
e3bdade88b
commit
e22e9c6fae
@ -6,6 +6,10 @@ We currently support two installation methods for DSFX: Docker and manual instal
|
||||
|
||||
### Docker
|
||||
|
||||
**pre-requisites**:
|
||||
|
||||
- docker
|
||||
|
||||
To run DSFX using Docker, you first need to log into the gitea registry. You can do this with the
|
||||
following command.
|
||||
|
||||
@ -18,5 +22,33 @@ echo $GITEA_PAT | docker login koti.casa -u <your-username> --password-stdin
|
||||
Then, you can pull the DSFX image from the registry and run it.
|
||||
|
||||
```bash
|
||||
docker run -d --name dsfx -p 8080:8080numenorlabs/dsfx
|
||||
docker run -d --name dsfx -p 8000:8000 koti.casa/numenorlabs/dsfx:latest
|
||||
```
|
||||
|
||||
### Manual Installation
|
||||
|
||||
**pre-requisites**:
|
||||
|
||||
- go
|
||||
|
||||
To install DSFX manually, you need to clone the repository and compile the code. You can do this with
|
||||
the following commands:
|
||||
|
||||
```bash
|
||||
git clone https://koti.casa/numenor-labs/dsfx.git
|
||||
|
||||
cd dsfx
|
||||
|
||||
go build -o <installation-target> ./cmd/dsfxnode
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
DSFX uses the following environment variables to configure its behavior:
|
||||
|
||||
| Variable | Description | Default Value |
|
||||
| -------------------- | ----------------------------------------------------------- | -------------------- |
|
||||
| DSFXNODE_PORT | The port on which the DSFX server will listen | 8000 |
|
||||
| DSFXNODE_HOST | The host on which the DSFX server will run | 0.0.0.0 |
|
||||
| DSFXNODE_CONFIG_DIR | The directory where the DSFX configuration files are stored | /etc/dsfxnode/config |
|
||||
| DSFXNODE_STORAGE_DIR | The directory where the DSFX storage files are stored | /etx/dsfxnode/data |
|
||||
|
Loading…
x
Reference in New Issue
Block a user