Skip to content

Commit

Permalink
fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
soulgalore committed May 29, 2024
1 parent 2be1f4f commit b8e84a4
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This project helps you set up your own online version of sitespeed.io. You get:

## Quick setup on your local machine

Follow these steps to quickly set up and run the online version of sitespeed.io. Make sure you have [Docker](https://www.docker.com), [docker-compose](https://docs.docker.com/compose/), [sitespeed.io](https://www.sitespeed.io/documentation/sitespeed.io/installation/) and [NodeJS](https://nodejs.org/) installed on your machine.
Follow these steps to quickly set up and run the online version of sitespeed.io on your local machine. Make sure you have [Docker](https://www.docker.com), [docker-compose](https://docs.docker.com/compose/), [sitespeed.io](https://www.sitespeed.io/documentation/sitespeed.io/installation/) and [NodeJS](https://nodejs.org/) installed on your machine.

1. **Clone the repository:**

Expand All @@ -38,13 +38,13 @@ Follow these steps to quickly set up and run the online version of sitespeed.io.
3. **Start the Docker containers (Redis/PostgreSQL/Minio):**

```bash
docker compose upen
docker compose up
```

4. **Open a new terminal tab or window and navigate to the server directory:**

```bash
cd online/server
cd server
```

5. **Start the server:**
Expand All @@ -56,7 +56,7 @@ Follow these steps to quickly set up and run the online version of sitespeed.io.
6. **Open another new terminal tab or window and navigate to the testrunner directory:**

```bash
cd online/testrunner
cd ../testrunner
```

7. **Start the testrunner:**
Expand All @@ -70,7 +70,7 @@ Now you can open your web browser and navigate to [http://127.0.0.1:3000](http:/

## What's in the box?

To get it up and running (the docker-compose file), you need:
To get it up and running (the [docker-compose file](https://github.com/sitespeedio/onlinetest/blob/main/docker-compose.yml)), you need:

* **A Message broker**: - A Redis-like data storage/message broker. The default setup uses [keydb](https://docs.keydb.dev) and has also been tested with [Valkey](https://github.com/valkey-io/valkey).

Expand Down
2 changes: 2 additions & 0 deletions server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,5 @@ You can also provide your own configuration file (recommended). The configuratio
```
node ./app.js --config /path/to/config.yaml
```

Take a copy of the [default configuration](https://github.com/sitespeedio/onlinetest/blob/main/server/config/default.yaml) and adapt it to your setup.

0 comments on commit b8e84a4

Please sign in to comment.