mir/vinyldns
2
0
Fork 0
mirror of https://github.com/VinylDNS/vinyldns synced 2025-08-22 02:02:14 +00:00
Code Issues Releases Wiki Activity

Merge pull request #1191 from JoshSEdwards/JoshSEdwards/documentation-for-apple-m1-support

Browse Source 
Update documentation for Apple M1 support
This commit is contained in:
Nicholas Spadaccino 2022-10-11 16:16:34 -04:00 committed by GitHub
commit fa03c5d398
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 56 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
DEVELOPER_GUIDE.md
View File

@ -10,6 +10,7 @@
* [Portal](#portal)
* [Documentation](#documentation)
- [Running VinylDNS Locally](#running-vinyldns-locally)
* [Support for M1 Macs](#support-for-m1-macs)
* [Starting the API Server](#starting-the-api-server)
* [Starting the Portal](#starting-the-portal)
- [Testing](#testing)
@ -161,6 +162,61 @@ settings for the microsite are also configured in `build.sbt` of the project roo
VinylDNS can be started in the background by running the [quickstart instructions](README.md#quickstart) located in the
README. However, VinylDNS can also be run in the foreground.
### Support for M1 Macs
If you are using a Mac running macOS with one of the new Apple M1 chips, you will need to update some dependencies to
newer versions before attempting to run VinylDNS locally. To verify whether your computer has one of these chips,
go to About This Mac in the Apple menu in the top-left corner of your screen. If next to Chip you see Apple M1,
or any later chip such as the Apple M1 Pro or Apple M1 Max, then you will need to apply these changes to the code.
#### build.sbt
Update protoc from version 2.6.1:
```shell
PB.targets in Compile := Seq(PB.gens.java("2.6.1") -> (sourceManaged in Compile).value),
PB.protocVersion := "-v261"
```
to version 3.21.7:
```shell
PB.targets in Compile := Seq(PB.gens.java("3.21.7") -> (sourceManaged in Compile).value),
PB.protocVersion := "-v3.21.7"
```
#### project/build.properties
Update `sbt.version=1.4.0` to `sbt.version=1.7.2`
#### project/Dependencies.scala
Update protobuf from version 2.6.1:
```shell
"com.google.protobuf" % "protobuf-java" % "2.6.1",
```
to version 3.21.7:
```shell
"com.google.protobuf" % "protobuf-java" % "3.21.7",
```
#### project/plugins.sbt
Update the sbt-protoc plugin from version 0.99.18:
```shell
addSbtPlugin("com.thesamet" % "sbt-protoc" % "0.99.18")
```
to version 1.0.6:
```shell
addSbtPlugin("com.thesamet" % "sbt-protoc" % "1.0.6")
```
### Starting the API Server
Before starting the API service, you can start the dependencies for local development: