Skip to content

Commit

Permalink
Merge pull request #383 from cmu-sei/v8
Browse files Browse the repository at this point in the history
updated docs from Austin W.
  • Loading branch information
sei-dupdyke committed Jul 30, 2024
2 parents ce26251 + 368b964 commit 45df01e
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
10 changes: 5 additions & 5 deletions docs/core/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,29 +67,29 @@ $ docker ps -a

If everything succeeds you should see the three new containers for the API, Grafana, and Postgres.

![Running Containers](../images/installing-the-api-running-containers.png)
![Running Containers](../../../images/api/installing-the-api-running-containers.png)

## Step 4 — Testing the API

By default, the API is hosted on port 5000. You should be able to reach the API from [http://localhost:5000](http://localhost:5000). If you open this page in your browser, you should see the initial API page outlining the version of the install, and a few test machine entries. If this page renders, your API is up, running, and available.

![Success!](../images/installing-the-api-success.png)
![Success!](../../images/api/installing-the-api-success.png)

## Troubleshooting

### Problem: The API home page has an error

![API Home Page Error](../images/installing-the-api-error.png)
![API Home Page Error](../../images/api/installing-the-api-error.png)

Answer: Make sure the docker container for Postgres is running using Docker Desktop or the command `docker ps -a`

![Running Containers](../images/installing-the-api-running-containers.png)
![Running Containers](../../images/api/installing-the-api-running-containers.png)

You can check the logs with the command `docker logs ghosts-postgres` to look for container errors.

### Problem: The social graph link has an error

![API Social Graph Page Error](../images/installing-the-api-social-error.png)
![API Social Graph Page Error](../../images/api/installing-the-api-social-error.png)

Answer: You haven't created a social network yet, this is normal.

Expand Down
10 changes: 5 additions & 5 deletions docs/core/grafana.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ $ docker ps -a

If the container is continuously restarting, Grafana does not have the permissions it needs.

![Grafana Restarting](../images/configuring-grafana-restarting.png)
![Grafana Restarting](../../images/grafana/configuring-grafana-restarting.png)

You can also check the docker logs:

```
$ docker logs ghosts-grafana
```

![Grafana Permission Denied](../images/configuring-grafana-permission-denied.png)
![Grafana Permission Denied](../../images/grafana/configuring-grafana-permission-denied.png)

If you don't see this issue, you can continue to Step 2. If you do see this issue you will need to grant permissions on the `_g` directory of the ghosts-api folder (which stores the Grafana data for the GHOSTS API).

Expand All @@ -43,7 +43,7 @@ Ensure the container is running with `docker ps`.

Once the container is running you can access its front end by default at [localhost:3000](http://localhost:3000)

![Grafana Front end](../images/configuring-grafana-front-end.png)
![Grafana Front end](../../images/grafana/configuring-grafana-front-end.png)

The default login is:

Expand Down Expand Up @@ -84,14 +84,14 @@ GHOSTS comes with some premade dashboards to get you started. You can download t

Navigate to "Dashboards" in the left menu. There will be a blue "New" button in the top right corner.

![Empty Dashboard](../images/configuring-grafana-empty-dashboard.png)
![Empty Dashboard](../../images/grafana/configuring-grafana-empty-dashboard.png)

Click "New". Then, "import".

You can either upload one of the dashboard json files from the GHOSTS repository or simply copy and paste the json into the "import via dashboard json model" panel.

Choose the ghosts datasource you added earlier from the drop down menu and then click "import".

![Ghosts In the Dashboard](../images/configuring-grafana-dashboard.png)
![Ghosts In the Dashboard](../../images/grafana/configuring-grafana-dashboard.png)

You are now set up with Grafana!

0 comments on commit 45df01e

Please sign in to comment.