Skip to content

Commit 3d37d2c

Browse files
committed
docs: Add iPad self signed certificate documentation
Closes #1816 Closes #1566
1 parent 724ceb6 commit 3d37d2c

File tree

3 files changed

+54
-0
lines changed

3 files changed

+54
-0
lines changed

ci/dev/fmt.sh

+1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ main() {
2626
doctoc --title '# Install' doc/install.md > /dev/null
2727
doctoc --title '# npm Install Requirements' doc/npm.md > /dev/null
2828
doctoc --title '# Contributing' doc/CONTRIBUTING.md > /dev/null
29+
doctoc --title '# iPad' doc/ipad.md > /dev/null
2930

3031
if [[ ${CI-} && $(git ls-files --other --modified --exclude-standard) ]]; then
3132
echo "Files need generation or are formatted incorrectly:"

doc/FAQ.md

+5
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
# FAQ
44

55
- [Questions?](#questions)
6+
- [iPad Status?](#ipad-status)
67
- [How can I reuse my VS Code configuration?](#how-can-i-reuse-my-vs-code-configuration)
78
- [Differences compared to VS Code?](#differences-compared-to-vs-code)
89
- [How can I request a missing extension?](#how-can-i-request-a-missing-extension)
@@ -33,6 +34,10 @@
3334

3435
Please file all questions and support requests at https://github.com/cdr/code-server/discussions.
3536

37+
## iPad Status?
38+
39+
Please see [./ipad.md](./ipad.md).
40+
3641
## How can I reuse my VS Code configuration?
3742

3843
The very popular [Settings Sync](https://marketplace.visualstudio.com/items?itemName=Shan.code-settings-sync) extension works.

doc/ipad.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
2+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
3+
# iPad
4+
5+
- [iPad](#ipad)
6+
- [How to access code-server with a self signed certificate on iPad](#how-to-access-code-server-with-a-self-signed-certificate-on-ipad)
7+
- [Known Issues](#known-issues)
8+
9+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
10+
11+
# iPad
12+
13+
## How to access code-server with a self signed certificate on iPad
14+
15+
The following instructions assume you have code-server installed with a self signed
16+
certificate.
17+
18+
If not, please first go through [./guide.md](./guide.md)!
19+
20+
**warning**: Your iPad must access code-server via a domain name. It could be local
21+
DNS like `mymacbookpro.local` but it must be a domain name. Otherwise Safari will
22+
refuse to allow WebSockets to connect.
23+
24+
The below assumes you are using the self signed certificate that code-server
25+
generates for you. If not, that's fine but you'll have to make sure your certificate
26+
abides by the following guidelines from apple: https://support.apple.com/en-us/HT210176
27+
28+
1. Your certificate **must** have a subject alt name that matches the hostname
29+
at which you will access code-server from your iPad. You can pass this to code-server
30+
so that it generates the certificate correctly with `--cert-host`.
31+
2. Share your self signed certificate with the iPad.
32+
- code-server will print the location of the certificate it has generated in the logs.
33+
34+
```
35+
[2020-10-30T08:55:45.139Z] info - Using generated certificate and key for HTTPS: ~/.local/share/code-server/mymbp_local.crt
36+
```
37+
38+
- You can mail it to yourself or if you have a Mac, it's easiest to just Airdrop.
39+
40+
3. When opening it, you'll be prompted that it is available to install in settings.
41+
4. Go to `Settings -> General -> Profile`, select the profile and then hit `Install`.
42+
5. Go to `Settings -> About -> Certificate Trust Settings` and enable full trust for
43+
the certificate.
44+
6. Now you can access code-server! 🍻
45+
46+
## Known Issues
47+
48+
There are a few known issues with the iPad support.

0 commit comments

Comments
 (0)