[docs] updated docs with authentication guide
This commit is contained in:
43
docs/getting-started/authenticating.md
Normal file
43
docs/getting-started/authenticating.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# Authenticating with Screeps
|
||||
|
||||
Screeps has recently introduced a [token-based auth system](http://blog.screeps.com/2017/12/auth-tokens/), and the old authentication system will be deprecated by 01 February 2018. The starter kit has been updated to support this new authentication process.
|
||||
|
||||
## Migrating to the new auth system
|
||||
|
||||
If you have an existing copy of your starter kit, follow these steps:
|
||||
|
||||
* Remove the `"username"` and `"password"` keys from your `screeps.json` file, and replace them with `"token"`.
|
||||
* Upgrade `rollup-plugin-screeps` to version 0.1.1.
|
||||
* Follow the authentication steps as defined below.
|
||||
|
||||
## Seting up Screeps authentication
|
||||
|
||||
The authentication token is pulled by the starter kit from a file named `screeps.json`. A sample config file (`screeps.sample.json`) is provided within the project, to use it, simply make a copy and rename it to `screeps.json`.
|
||||
|
||||
```bash
|
||||
cp screeps.sample.json screeps.json
|
||||
```
|
||||
|
||||
> **IMPORTANT:** The `screeps.json` file contains your Screeps credentials. If you use any source control, **DO NOT** check in this file into your repository.
|
||||
|
||||
## Generating an auth token
|
||||
|
||||
To generate an authentication token, click **[your username] > Manage account**. You should see the **Auth tokens** in the options now, click it.
|
||||
|
||||

|
||||
|
||||
On the next screen, we'll create a full access token. We pick the **Full access** option, then click the **Generate Token** button.
|
||||
|
||||

|
||||
|
||||
Your generated token should now be shown on your screen. Copy it to your clipboard.
|
||||
|
||||

|
||||
|
||||
> **Note:** This token will be displayed **only once**! Make sure to never lose it. However, if you did lose it, simply remove said token from your account, and create a new one.
|
||||
|
||||
Now, paste it to your `screeps.json` file.
|
||||
|
||||

|
||||
|
||||
Congratulations, you've successfully authenticated! Next up, we'll configure our environment and [run our first code deploy](./deploying.md).
|
||||
@@ -2,17 +2,11 @@
|
||||
|
||||
## Building your configuration file
|
||||
|
||||
The starter kit builds your code using `rollup`, which uses a `screeps.json` file as its configuration file. A sample config file is provided within the project, to use it, simply make a copy and rename it to `screeps.json`.
|
||||
The starter kit builds your code using `rollup`, which uses a `screeps.json` file we built on the previous section as its configuration file.
|
||||
|
||||
```bash
|
||||
cp screeps.sample.json screeps.json
|
||||
```
|
||||
The `screeps.json` file is a JSON configuration file separated into multiple environments. We're going to focus on the `main` environment to get you started. If you'd like to deploy to a different branch, be sure to change the `branch` key to the branch you'd like to deploy to.
|
||||
|
||||
> **IMPORTANT:** The `screeps.json` file contains your Screeps credentials. If you use any source control, **DO NOT** check in this file into your repository.
|
||||
|
||||
The `screeps.json` file is a JSON configuration file separated into multiple environments. We're going to focus on the `main` environment to get you starter. Fill in your Screeps credentials accordingly, along with your target branch.
|
||||
|
||||

|
||||

|
||||
|
||||
> **Note:** You don't have to manually create the target branch in your Screeps client if it doesn't exist yet. `rollup-plugin-screeps` will do it for you.
|
||||
|
||||
|
||||
BIN
docs/getting-started/img/authenticating-1.png
Normal file
BIN
docs/getting-started/img/authenticating-1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.4 KiB |
BIN
docs/getting-started/img/authenticating-2.png
Normal file
BIN
docs/getting-started/img/authenticating-2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
BIN
docs/getting-started/img/authenticating-3.png
Normal file
BIN
docs/getting-started/img/authenticating-3.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
BIN
docs/getting-started/img/authenticating-4.png
Normal file
BIN
docs/getting-started/img/authenticating-4.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
@@ -22,4 +22,4 @@ Or if you're running `yarn`:
|
||||
yarn
|
||||
```
|
||||
|
||||
Next up, we'll configure our environment and [run our first code deploy](./deploying.md).
|
||||
Once that's all done, let's [authenticate with the Screeps server](./authenticating.md).
|
||||
|
||||
Reference in New Issue
Block a user