> For the complete documentation index, see [llms.txt](https://docs.nxcframework.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nxcframework.net/start-here/installing.md).

# Installing

Getting Nexus Core onto a server.

Two ways. The recipe is easier and reinstalls everything; the manual route is what you use once you have a server you care about.

## With the txAdmin recipe

The recipe provisions resources and configuration onto a server that already exists. It does **not** install or verify your server artifacts — see [What you need](/start-here/requirements.md).

```
https://raw.githubusercontent.com/NC-Framework/NXC_TXAdmin/main/NexusCore.yml
```

> **Re-running the recipe discards every edit you have made.** txAdmin deploys into a new data directory and regenerates `server.cfg` from the template. The previous directory, and everything you changed in it, is gone.
>
> Before redeploying, keep a copy of: your endpoint ports, the database connection string, the token signing key, and `nxc_server_build`.

## By hand

Download each resource at the version named in the current [compatibility set](/reference/compatibility-sets.md) and put them in `resources/[nexus]/`.

```
https://github.com/NC-Framework/nxc_lib/archive/refs/tags/vX.Y.Z.zip
https://github.com/NC-Framework/nxc_core/archive/refs/tags/vX.Y.Z.zip
https://github.com/NC-Framework/nxc_config/archive/refs/tags/vX.Y.Z.zip
https://github.com/NC-Framework/nxc_ui/archive/refs/tags/vX.Y.Z.zip
https://github.com/NC-Framework/nxc_zones/archive/refs/tags/vX.Y.Z.zip
https://github.com/NC-Framework/nxc_target/archive/refs/tags/vX.Y.Z.zip
```

**Install the whole set, at the versions the set names.** Mixing versions from different sets is unsupported and the failures are confusing rather than obvious.

Keep `nxc_ui/web/dist/` — that is the built interface, and there is no build step on your server.

## Then

Fill in the required values in `server.cfg` — see the [server.cfg reference](/configuring/server-cfg.md) — and start in this order:

```cfg
ensure oxmysql

ensure nxc_lib
ensure nxc_core
ensure nxc_config
ensure nxc_ui
ensure nxc_zones
ensure nxc_target
```

Order matters. Each resource assumes the ones above it are available.

Then read [Your first start](/start-here/first-start.md), which tells you what a successful startup looks like so you can tell it apart from a broken one.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.nxcframework.net/start-here/installing.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
