> ## Documentation Index
> Fetch the complete documentation index at: https://namehash-krzysztofwrobel-sc-24494-nameguard-remove-goerli-a.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Self-Hosting

> Run NameGuard yourself and protect against malicious ENS names.

## Quickstart

<Steps>
  <Step title="Install NameGuard">
    ```bash
    pip install nameguard
    ```
  </Step>

  <Step title="Configure API keys">
    ```bash
    export PROVIDER_URI_MAINNET=https://eth-mainnet.g.alchemy.com/v2/[YOUR_ALCHEMY_API_KEY]
    export PROVIDER_URI_SEPOLIA=https://eth-sepolia.g.alchemy.com/v2/[YOUR_ALCHEMY_API_KEY]
    ```
  </Step>

  <Step title="Install a server">
    ```bash
    pip install 'uvicorn[standard]'
    ```
  </Step>

  <Step title="Start the web server">
    ```bash
    uvicorn nameguard.web_api:app
    ```
  </Step>
</Steps>

## Local Development

To run NameGuard locally, make sure to clone the repo:

```bash
git clone https://github.com/namehash/nameguard
```

Then install the dependencies using `poetry`:

```bash
cd nameguard
poetry install
```

You can now run the tests for all checks outlined in the [specification](/specification). From the root of the project, run the following command:

```bash
pytest ./api/tests/
```