Skip to content

Commit

Permalink
Docs: Added instructions for how to use config-overrides.plist (googl…
Browse files Browse the repository at this point in the history
…e#1077)

* Added instructions for how to use config-overrides

---------

Co-authored-by: Russell Hancox <russellhancox@users.noreply.github.com>
  • Loading branch information
pmarkowsky and russellhancox authored May 1, 2023
1 parent bf3b6bc commit fc4e29f
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion docs/development/building.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,31 @@ Run all the logic / unit tests
bazel test :unit_tests --define=SANTA_BUILD_TYPE=adhoc --test_output=errors
```

##### Testing Config Options Using `/var/db/santa/config-overrides.plist`

Debug versions of Santa have the ability to set/override config settings using an override file, that will be applied over the top of the configuration from a profile.

1. Create a plist in `/var/db/santa/config-overrides.plist`

For example to point Santa at a sync server running on localhost here would be the config-override file.

```xml
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>SyncBaseURL</key>
<string>http://localhost:8080/v1/santa/</string>
<key>SyncClientContentEncoding</key>
<string>gzip</string>
</dict>
</plist>
```

> :warning: Warning
> Make sure the file is readable.
2. run `bazel run //:reload` to rebuild and restart the Santa daemon.

#### Releases

Creates a release build of Santa with a version based of the newest tag. Also
Expand All @@ -136,5 +161,5 @@ interpreting future crashes much easier. Releases are handled by Google internal
infrastructure.

```sh
bazel build --apple_generate_dsym -c opt :release
bazel build --apple_generate_dsym -c opt //:release
```

0 comments on commit fc4e29f

Please sign in to comment.