Update readme. Update login feature.

rdbeach · rdbeach · commit 7b271e67e412 · 2020-11-27T11:30:42.000-08:00
diff --git a/.DS_Store b/.DS_Store
diff --git a/README.md b/README.md
@@ -1,69 +1,104 @@
-# code-server &middot; [!["GitHub Discussions"](https://img.shields.io/badge/%20GitHub-%20Discussions-gray.svg?longCache=true&logo=github&colorB=purple)](https://github.com/cdr/code-server/discussions) [!["Join us on Slack"](https://img.shields.io/badge/join-us%20on%20slack-gray.svg?longCache=true&logo=slack&colorB=brightgreen)](https://cdr.co/join-community) [![Twitter Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq)
+# Coderpair vscode-live
 
 Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser.
 
-![Screenshot](./doc/assets/screenshot.png)
+Set up multiple user accounts. Each user may have their own preferences/settings.
 
-## Highlights
+Collaborate with your team in real time.
 
-- Code on any device with a consistent development environment
-- Use cloud servers to speed up tests, compilations, downloads, and more
-- Preserve battery life when you're on the go; all intensive tasks run on your server
+![Screenshot](./doc/assets/screenshot.png)
 
 ## Getting Started
 
-There are two ways to get started:
+This is an extension of [code-server's](https://github.com/cdr/code-server) release of vscode.
+
+Almost all the info that you need can be found on the [code-server](https://github.com/cdr/code-server) page. The only thing that will be covered here are the differences.
+
+## Installing
+
+Get the latest release here. Go to the code-server [installation](https://github.com/cdr/code-server/blob/v3.7.3/doc/install.md) page. Refer to the instructions for manual installation for your particular environment.
+
+## Setup
 
-1. Using the [install script](./install.sh), which automates most of the process. The script uses the system package manager (if possible)
-2. Manually installing code-server; see [Installation](./doc/install.md) for instructions applicable to most use cases
+Run code-server according to the instructions in the installation page above and visit the code-server page in your browser. If everything looks OK, you are ready to start setting up vscode-live.
 
-If you choose to use the install script, you can preview what occurs during the install process:
+When `code-server` starts up, it creates a default config file in `~/.config/code-server/config.yaml` that looks
+like this:
 
-```bash
-curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run
+```yaml
+bind-addr: 127.0.0.1:8080
+auth: password
+password: mewkmdasosafuio3422 # This is randomly generated for each config.yaml
+admin: osdifnasdfiopsdfn3556 # This is randomly generated for each config.yaml
+cert: false
 ```
 
-To install, run:
+The `password` field is what you use to log in to code-server as the default user. 
 
-```bash
-curl -fsSL https://code-server.dev/install.sh | sh
+`admin` is a secondary password that you use for making changed through the dashboard.
+
+## Setting up Firebase
+You will need a Firebase account to use the real time collaboration feature. You can [sign up here for a free account](https://console.firebase.google.com/).
+
+After signing up, edit the `config.yaml` so that it looks like this:
+
+```yaml
+bind-addr: 127.0.0.1:8080
+auth: password
+password: mewkmdasosafuio3422 # This is randomly generated for each config.yaml
+admin: osdifnasdfiopsdfn3556 # This is randomly generated for each config.yaml
+cert: false
+firebase-apiKey: '<API_KEY>'
+firebase-authDomain: '<DATABASE_NAME>.firebaseapp.com'
+firebase-databaseURL: 'https://<DATABASE_NAME>.firebaseio.com'
+firebase-ref: '-MCyz2LOkxQUSJBASlcG'
 ```
 
-When done, the install script prints out instructions for running and starting code-server.
+Fill in the `<API_KEY>` and `<DATABASE_NAME>` with your Firebase settings. You can leave the `firebase-ref` field as is or change it if you feel like it! Restart code-server for the changes to go into effect.
 
-We also have an in-depth [setup and configuration](./doc/guide.md) guide.
+Skip to [Turn on real time collaboration](#turn-on-real-time-collaboration) if you don't want to set up multiple accounts.
 
-### Alpha Program 🐣
+## Setting up multiple accounts
 
-We're working on a cloud platform that makes deploying and managing code-server easier. Consider [updating to 3.6.2](https://github.com/cdr/code-server/releases/tag/v3.6.2) and running code-server with our experimental flag `--link` if you don't want to worry about
+You can set up an account for each of your team members. Each user will be able to use vscode-live with their own default settings.
 
-- TLS
-- Authentication
-- Port Forwarding
+In order to set up multiple accounts, add a `users` field to the  `config.yaml` file so that it looks like this:
 
-```bash
-$ code-server --link
-Proxying code-server to Coder Cloud, you can access your IDE at https://valmar-jon.cdr.co
+```yaml
+bind-addr: 127.0.0.1:8080
+auth: password
+password: mewkmdasosafuio3422 # This is randomly generated for each config.yaml
+admin: osdifnasdfiopsdfn3556 # This is randomly generated for each config.yaml
+cert: false
+firebase-apiKey: '<API_KEY>'
+firebase-authDomain: '<DATABASE_NAME>.firebaseapp.com'
+firebase-databaseURL: 'https://<DATABASE_NAME>.firebaseio.com'
+firebase-ref: '-MCyz2LOkxQUSJBASlcG'
+users: {
+  robert: {password: pswd1, role: admin},
+  sara: {password: pswd2, role: user}
+  leonardo: {password: pswd3, role: user}
+}
 ```
 
-## FAQ
+Restart code-server for the changes to go into effect.
+
+You can add as many accounts as you like. You will log in to code server with password you specify, so make sure it is a secure password.
+
+Go to the login page in your browser
 
-See [./doc/FAQ.md](./doc/FAQ.md).
+ie http://localhost:8080/login  
 
-## Want to help?
+and sign in with one of the user accounts.
 
-See [CONTRIBUTING](./doc/CONTRIBUTING.md) for details.
+## Turning on real time collaboration
 
-## Hiring
+Head over to the dashboard:
 
-We ([@cdr](https://github.com/cdr)) are looking for engineers to help [maintain
-code-server](https://jobs.lever.co/coder/e40becde-2cbd-4885-9029-e5c7b0a734b8), innovate on open source, and streamline dev workflows.
+ie http://localhost:8080/dashboard  
 
-Our main office is in Austin, Texas. Remote is ok as long as
-you're in North America or Europe.
+go to the real time collaboration section, and turn it on there. Make sure you use the `admin` password in the config file to make changes.
 
-Please get in [touch](mailto:jobs@coder.com) with your resume/GitHub if interested.
+Have fun!
 
-## For Organizations
 
-Visit [our website](https://coder.com) for more information about remote development for your organization or enterprise.
diff --git a/src/node/app/login.ts b/src/node/app/login.ts
@@ -38,12 +38,14 @@ export class LoginHttpProvider extends HttpProvider {
             return this.tryLogin(route, request)
           default:
             this.ensureMethod(request)
+            /*
             if (this.authenticated(request)) {
               return {
                 redirect: (Array.isArray(route.query.to) ? route.query.to[0] : route.query.to) || "/",
                 query: { to: undefined },
               }
             }
+            */
             return this.getRoot(route)
         }
     }
@@ -71,7 +73,7 @@ export class LoginHttpProvider extends HttpProvider {
     // Already authenticated via cookies?
    
     const userData = this.authenticated(request)
-    if (userData) {
+    if (userData && request.method != "POST") {
       return { code: HttpCode.Ok }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -38,12 +38,14 @@ export class LoginHttpProvider extends HttpProvider {`
`38`	`38`	`return this.tryLogin(route, request)`
`39`	`39`	`default:`
`40`	`40`	`this.ensureMethod(request)`
	`41`	`+ /*`
`41`	`42`	`if (this.authenticated(request)) {`
`42`	`43`	`return {`
`43`	`44`	`redirect: (Array.isArray(route.query.to) ? route.query.to[0] : route.query.to) \|\| "/",`
`44`	`45`	`query: { to: undefined },`
`45`	`46`	`}`
`46`	`47`	`}`
	`48`	`+ */`
`47`	`49`	`return this.getRoot(route)`
`48`	`50`	`}`
`49`	`51`	`}`
`@@ -71,7 +73,7 @@ export class LoginHttpProvider extends HttpProvider {`
`71`	`73`	`// Already authenticated via cookies?`
`72`	`74`
`73`	`75`	`const userData = this.authenticated(request)`
`74`		`- if (userData) {`
	`76`	`+ if (userData && request.method != "POST") {`
`75`	`77`	`return { code: HttpCode.Ok }`
`76`	`78`	`}`
`77`	`79`