Skip to content

Update MANUAL_INSTALL.md with integration test note #7139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
simonpoole wants to merge 1 commit into
base: master
Choose a base branch
from
+30 −1
Open

Update MANUAL_INSTALL.md with integration test note #7139

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion doc/MANUAL_INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,20 @@ sudo apt-get install ruby ruby-dev ruby-bundler \
sudo npm install --global yarn
```

Running tests requires Firefox and WebGL support

```bash
sudo apt-get install firefox mesa-utils libosmesa6 xvfb
```

Firefox will be installed with snap and you will need to add

```
system_test_firefox_binary: /snap/firefox/current/usr/lib/firefox/firefox
```

to config/settings/test.local.yml

> [!TIP]
> On Ubuntu 26.04, you may need to start PostgreSQL:
>
Expand Down Expand Up @@ -131,7 +145,15 @@ We use [Bundler](https://bundler.io/) to manage the rubygems required for the pr
```bash
cd openstreetmap-website
bundle install
```

> [NOTE]
> On Ubuntu 26.04 the version of bundle installed is old and will not install the gems, you can
> upgrade with
>
> ```bash
> sudo bundle update --bundler
> ```
> however this will install the gems as root which may or may not be what you want.

### Node.js modules

Expand Down Expand Up @@ -211,6 +233,13 @@ This test will take a few minutes, reporting tests run, assertions, and any erro

> [!NOTE]
> The unit tests may output parser errors related to "Attribute lat redefined." These can be ignored.
>
> For the tests that use WebGL to complete successfully on an headless machine you need to start an X server rendering on the virtual framebuffer
> an easy way to do that is to use the docker entrypoint script
>
> ```bash
> docker/entrypoint.sh bundle exec rails test:all
> ```

### Starting the server

Expand Down