# Getting Started

> Get started with psLens: install the SWS framework, deploy psLens, and connect it to your PeopleSoft environment in minutes.

---

LLMS index: [llms.txt](/llms.txt)

---

## Getting Started with psLens

Install SWS in PeopleSoft, run the psLens container, point it at SWS, log in. The pages in order:

### Overview

psLens is a single self-contained application: a Go binary that serves the web interface and stores report data locally. There is no separate database to manage. It connects to your PeopleSoft environment through the **SWS (Secure Web Services) framework**, which must be installed and configured in PeopleSoft first.

<figure><img src="/images/screenshots/dashboard-alerts.png"
    alt="psLens Dashboard showing active alerts and database connections"><figcaption>
      <p>The psLens dashboard — your starting point for monitoring PeopleSoft environments</p>
    </figcaption>
</figure>


> **Hosting psLens in production?** Read [Deployment Options](/docs/getting-started/deployment-options/) for HTTPS, version pinning, backups, and upgrade paths.

### Setup Steps

1. **[Read the Architecture Overview](/docs/getting-started/architecture/)** to see how the pieces fit together
2. **[Install the SWS Framework](/docs/getting-started/installation/#step-1-install-the-sws-framework-in-peoplesoft)** in your PeopleSoft environment
3. **[Install psLens](/docs/getting-started/installation/#step-2-install-pslens)** on your server
4. **[Configure psLens](/docs/getting-started/configuration/)** with your database connection details
5. Start psLens and open the dashboard in your browser

### Quick Start

Once the SWS framework is installed in PeopleSoft:

```bash
# Create a directory for psLens
mkdir pslens && cd pslens

# Create config.yaml with your PeopleSoft connection details
# (see Configuration for full details)

# Start psLens with Docker
docker compose up -d

# Open http://localhost:8080 in your browser
```

---

Section pages:

- [Installation](/docs/getting-started/installation/)
- [Whitelist Tables](/docs/getting-started/whitelist-tables/)
- [Configuration](/docs/getting-started/configuration/)
- [Deployment Options](/docs/getting-started/deployment-options/)
- [Architecture Overview](/docs/getting-started/architecture/): How psLens connects to PeopleSoft: a small SWS framework inside your PeopleSoft environment, and a psLens Docker container hosted externally.