Skip to content

selfhosted-guide: make it clear when to run configure.sh #419

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 27, 2025
Merged

selfhosted-guide: make it clear when to run configure.sh #419

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/pages/selfhosted/selfhosted-guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,10 @@ NETBIRD_AUTH_DEVICE_AUTH_CLIENT_ID=""
NETBIRD_LETSENCRYPT_EMAIL=""
```

<Note>
The changes made to `setup.env` will not take any effect until you run `configure.sh` (mentioned later on).
</Note>

- Set ```NETBIRD_DOMAIN``` to your domain, e.g. `demo.netbird.io`
- Configure ```NETBIRD_LETSENCRYPT_EMAIL``` property.
This can be any email address. [Let's Encrypt](https://letsencrypt.org/) will create an account while generating a new certificate.
Expand Down Expand Up @@ -124,6 +128,10 @@ Make sure all the required properties set in the ```setup.env``` file and run:

This will export all the properties as environment variables and generate ```artifacts/docker-compose.yml```, ```artifacts/management.json``` and ```artifacts/turnserver.conf``` files substituting required variables.

<Note>
The changes made to `setup.env` will not take any effect until you run `configure.sh` again
</Note>

### Step 6: Run docker compose:

```bash
Expand Down