Skip to content

Commit 8a3db1b

Browse files
committed
docs: update important notes
1 parent b7e9756 commit 8a3db1b

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,24 @@ This is a free and simple builder server for [ios-signer-service](https://github
44

55
You only need to configure one builder. If you already configured a CI provider as your builder, you don't need to do anything here. This project is aimed at people who want to have a self-hosted builder.
66

7+
## Important
8+
9+
### Security
10+
11+
This server requires the use of an authentication key so that only the web service can control your builder. However, there is no built-in support for HTTPS or any other form of encryption. Therefore:
12+
13+
> :warning: **Anybody with access to the builder's network can potentially manipulate the builder to execute any code that they want on your machine.**
14+
15+
To prevent this, only deploy this server in a trusted environment, or even better, wrap the server in HTTPS yourself using a reverse proxy like nginx.
16+
17+
### Side effects on your Mac
18+
19+
While the server will do its best to keep changes to your Mac at a minimum, certain changes are inevitable. The biggest one to know is:
20+
21+
> :warning: **Your keychain will be swapped out during signing and restored back afterwards.**
22+
23+
It is highly recommended that you dedicate this Mac exclusively as a builder. Using it for other purposes, especially at the same time as a sign job is running, could lead to random issues.
24+
725
## Setup
826

927
All the steps should be performed on your builder Mac.
@@ -21,21 +39,13 @@ All the steps should be performed on your builder Mac.
2139
rm master.zip
2240
```
2341

24-
Important:
25-
2642
> :warning: **Remember to update the signing files from above every time that you update the signing service. Otherwise you may experience random issues.**
2743
28-
This server requires the use of an authentication key so that only the web service can control your builder. However, there is no built-in support for HTTPS or any other form of encryption. Therefore:
29-
30-
> :warning: **Anybody with access to the builder's network can potentially manipulate the builder to execute any code that they want on your machine.**
31-
32-
To prevent this, only deploy this server in a trusted environment, or even better, wrap the server in HTTPS yourself using a reverse proxy like nginx.
33-
34-
The authentication key has to be at least 8 characters long. Note it down - you will need to put it in your `ios-signer-service`'s configuration file later on.
35-
3644
## Running
3745

38-
When starting the server, you will want to use the same auth key and signing files from above and pass them as arguments:
46+
You need to make up an authentication key. It has to be at least 8 characters long. Note it down - you will need to put it in your `ios-signer-service`'s configuration file later on.
47+
48+
To start the server, use the auth key and signing files from before and pass them as arguments:
3949

4050
```bash
4151
./ios-signer-builder -key "SOME_SECRET_KEY" -files "ios-signer-ci-master"

0 commit comments

Comments
 (0)