docs: document how to run the portal

This commit is contained in:
Sérgio Ramos 2018-03-12 11:29:45 +00:00
parent d87c4e017b
commit 2787f051e0
4 changed files with 40 additions and 1 deletions

View File

@ -28,7 +28,10 @@ export default (opts = {}) => {
credentials: 'same-origin', credentials: 'same-origin',
fetch, fetch,
headers: { headers: {
'X-CSRF-Token': global.cookie.replace(/(?:(?:^|.*;\s*)crumb\s*=\s*([^;]*).*$)|^.*$/, '$1') 'X-CSRF-Token': global.cookie.replace(
/(?:(?:^|.*;\s*)crumb\s*=\s*([^;]*).*$)|^.*$/,
'$1'
)
} }
}), }),
...opts ...opts

36
running.md Normal file
View File

@ -0,0 +1,36 @@
# How to run the Joyent Portal
#### Requisites
- [ ] [Install node.js](https://nodejs.org/en/download/current/)
- [ ] [Install Yarn](https://yarnpkg.com/en/docs/install)
- [ ] [Setup node-triton](https://github.com/joyent/node-triton#setup)
## via [webconsole-instances](https://github.com/joyent/webconsole-instances)
[webconsole-instances](https://github.com/joyent/webconsole-instances) is the stable version of the portal. It gets updated with stable releases from [joyent-portal](http://github.com/yldio/joyent-portal).
```
➜ git clone https://github.com/joyent/webconsole-instances
➜ cd webconsole-instances
➜ yarn
➜ ./gen-keys.sh
➜ ./setup.sh # use instructions from previous step
➜ sed -i -e 's/production/development/g' _env
➜ docker-compose -f local-compose.yml up
➜ # visit http://localhost:80
```
## via [joyent-portal](http://github.com/yldio/joyent-portal)
[joyent-portal](http://github.com/yldio/joyent-portal) is the unstable and in-development version of the portal. It may be broken at any point in time.
```
➜ git clone https://github.com/yldio/joyent-portal
➜ cd joyent-portal
➜ yarn
➜ yarn run build:bundle
➜ cd bundle
➜ eval "$(triton env <your profile>)"
➜ yarn run start
```