diff options
author | Chocobozzz <florian.bigard@gmail.com> | 2017-11-27 16:06:13 +0100 |
---|---|---|
committer | Chocobozzz <florian.bigard@gmail.com> | 2017-11-27 19:43:01 +0100 |
commit | fcaf1e0aa84213a1b1f1b1a44a3276eae35ebe70 (patch) | |
tree | 23157ef819c5dba040a576b8dae0dee4eba6e85f /support | |
parent | 4e50b6a1c9a3eb261e04ede73241648e6edf21d6 (diff) | |
download | PeerTube-fcaf1e0aa84213a1b1f1b1a44a3276eae35ebe70.tar.gz PeerTube-fcaf1e0aa84213a1b1f1b1a44a3276eae35ebe70.tar.zst PeerTube-fcaf1e0aa84213a1b1f1b1a44a3276eae35ebe70.zip |
Update readme, architecture
Diffstat (limited to 'support')
-rw-r--r-- | support/doc/server/code.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/support/doc/server/code.md b/support/doc/server/code.md index b941304ce..f0ed62acc 100644 --- a/support/doc/server/code.md +++ b/support/doc/server/code.md | |||
@@ -28,7 +28,7 @@ All other server files are in the [server](https://github.com/Chocobozzz/PeerTub | |||
28 | |__ initializers -> functions used at the server startup (installer, database, constants...) | 28 | |__ initializers -> functions used at the server startup (installer, database, constants...) |
29 | |__ lib -> library function (WebTorrent, OAuth2, friends logic...) | 29 | |__ lib -> library function (WebTorrent, OAuth2, friends logic...) |
30 | |__ middlewares -> middlewares for controllers (requests validators, requests pagination...) | 30 | |__ middlewares -> middlewares for controllers (requests validators, requests pagination...) |
31 | |__ models -> Sequelize models for each SQL tables (videos, users, pods...) | 31 | |__ models -> Sequelize models for each SQL tables (videos, users, accounts...) |
32 | |__ tests -> API tests and real world simulations (to test the decentralized feature...) | 32 | |__ tests -> API tests and real world simulations (to test the decentralized feature...) |
33 | 33 | ||
34 | 34 | ||
@@ -44,11 +44,11 @@ Uses [JavaScript Standard Style](http://standardjs.com/). | |||
44 | * Run PostgreSQL and create the database `peertube_dev`. | 44 | * Run PostgreSQL and create the database `peertube_dev`. |
45 | * Run `npm run dev:server` to run the server, watch server files modifications and restart it automatically. The server (API + client) listen on `localhost:9000`. | 45 | * Run `npm run dev:server` to run the server, watch server files modifications and restart it automatically. The server (API + client) listen on `localhost:9000`. |
46 | 46 | ||
47 | The `NODE_ENV=test` is set to speed up communications between pods (see [constants.ts](https://github.com/Chocobozzz/PeerTube/blob/master/server/initializers/constants.ts)). | 47 | The `NODE_ENV=test` is set to speed up communications between instances (see [constants.ts](https://github.com/Chocobozzz/PeerTube/blob/master/server/initializers/constants.ts)). |
48 | 48 | ||
49 | `npm run help` gives you all available commands. | 49 | `npm run help` gives you all available commands. |
50 | 50 | ||
51 | If you want to test the decentralization feature, you can easily run 3 pods by running `npm run play`. The pods password are `test1`, `test2` and `test3`. | 51 | If you want to test the decentralization feature, you can easily run 3 instances by running `npm run play`. The instances password are `test1`, `test2` and `test3`. |
52 | 52 | ||
53 | 53 | ||
54 | ## Architecture | 54 | ## Architecture |