Skip to content
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

Jump to bottom

Update macOS dev docs #16625

Merged
merged 9 commits into from
Sep 6, 2024
Merged

Update macOS dev docs #16625

Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
2f91859
Update README.md
mrmir Sep 4, 2024
663b0ec
Readme: database connection instructions
Sep 5, 2024
14b1352
Readme: imagemagick and java installation
Sep 5, 2024
8fbd88c
README: Mac OS X -> macOS
Sep 5, 2024
5fa15b1
Incorporate suggestions
mrmir Sep 5, 2024
e0862db
Use macOS in headline
Sep 5, 2024
2b20ddd
macOS dev guide: add Shell profile instructions
Sep 6, 2024
80aeca7
Readme: fix typo
Sep 6, 2024
c57d025
Readme: better wording
Sep 6, 2024
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
29 changes: 24 additions & 5 deletions docs/development/development-environment/macos/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ description: OpenProject development setup on Mac OS
keywords: development setup macos
---

# OpenProject development setup on Mac OS X
# OpenProject development setup on macOS

To develop OpenProject a setup similar to that for using OpenProject in production is needed.

This guide assumes that you have a Mac OS X installation with administrative rights.
This guide assumes that you have a macOS installation with administrative rights.
OpenProject will be installed with a PostgreSQL database.

**Please note**: This guide is NOT suitable for a production setup, but only for developing with it!
Expand Down Expand Up @@ -75,10 +75,11 @@ steps.

```shell
# Install postgres database
$ brew install postgres
$ brew install postgresql

# Create the database instance
$ postgres -D /usr/local/var/postgres
# Confirm that postgres has created a default database cluster if you see
This formula has created a default database cluster with:
initdb --locale=C -E UTF-8 /opt/homebrew/var/postgresql@14 # /usr/local for Intel Macs
```

Then, create the OpenProject database user and accompanied database.
Expand Down Expand Up @@ -172,6 +173,10 @@ It should look like this (just with your database name, username, and password):
default: &default
adapter: postgresql
encoding: unicode
# Socket encryption must be disabled on macOS. There is an old bug in which forked processes cause problems on a Mac.
# TL;DR: set this flag, otherwise Ruby will crash whenever a route is accessed.
# Visit https://github.com/ged/ruby-pg/issues/311 to enter the rabbit hole.
gssencmode: disable
EinLama marked this conversation as resolved.
Show resolved Hide resolved
host: localhost
username: openproject
password: openproject-dev-password
Expand All @@ -189,6 +194,20 @@ To configure the environment variables such as the number of web server threads
the `.env.example` to `.env` and add the environment variables you want to configure. The variables will be
automatically loaded to the application's environment.

### Install other requirements

Some operations in OpenProject require additional software. These include PDF exports and interaction with an
LDAP server.

In order to develop OpenProject in these areas, you need to install `imagemagick` and `java`.

```shell
brew install imagemagick java
```

As of writing, you need to manually create a symlink to OpenJDK for the Java installation to take effect. Homebrew will
tell you how.

### Finish the Installation of OpenProject

Install code dependencies, link plugin modules and export translation files.
Expand Down