diff --git a/.gitignore b/.gitignore index 9ced34fb847c..0f51c735c971 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ dist out .DS_Store release +*.pem diff --git a/README.md b/README.md index 22d720ad5a10..dc0e4ea2531f 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,25 @@ How to [secure your setup](/doc/security/ssl.md). ## Contributing -Development guides are coming soon. +### Getting started + +With localhost ssl (optional): + +``` +brew install mkcert +mkcert -install +mkcert localhost ::1 127.0.0.1 +``` + +Running code-server: +``` +yarn install +yarn task vscode:install +# without ssl +yarn start --password=password --allow-http +# with ssl +yarn start --cert=$(pwd)/localhost+2.pem --cert-key=$(pwd)/localhost+2-key.pem --password=password +``` ## License