Skip to content

Update readme to explain firebase setup better. #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,20 @@ The `password` field is what you use to log in to code-server as the default use
## 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:
After signing up, creat a project and navigate to "Realtime Database" under the "Build" tab on the left side of the website. Once there you should see button that says "Create Database", click on it and there will be a pop up asking what server you want your database stored on, for this to work you will have to select "us-central 1" as the server.<!-- correct me if I'm wrong here --> Once you have selected the server click next. Now you have to choose you security rules, it doesn't matter which opption you select because you will have to change it anyway. Now hit enable to enable your database.

In order to let vscode-live access your database you need to change the database rules. To do this navigate to the rules tab of your database page, once there chage the rules so they look like this:

```yaml
{
"rules": {
".read": true,
".write": true
}
}
```

After setting up the database, edit the `config.yaml` so that it looks like this:

```yaml
bind-addr: 127.0.0.1:8080
Expand Down