diff --git a/Docs/src/content/docs/br/development/Client/Guide/docs-write-edit-documents.mdx b/Docs/src/content/docs/br/development/Client/Guide/docs-write-edit-documents.mdx index 8c69f65556..9a15ea33b3 100644 --- a/Docs/src/content/docs/br/development/Client/Guide/docs-write-edit-documents.mdx +++ b/Docs/src/content/docs/br/development/Client/Guide/docs-write-edit-documents.mdx @@ -26,7 +26,6 @@ Para qualquer documento que deseje criar, ele deve residir em algum lugar dentro A estrutura de pastas dentro disso é semelhante à hierarquia da barra lateral no site.\ Primordialmente, existem 3 seções principais: -* [Documentação de Design](design) * [Documentação de Desenvolvimento](development) * [Documentação sobre como executar torneios via Corsace](tournaments) * [Documentation on playing in tournaments run via Corsace](../../../../tournament_play) diff --git a/Docs/src/content/docs/br/development/Server/Guide/centrifugo-running-environment.mdx b/Docs/src/content/docs/br/development/Server/Guide/centrifugo-running-environment.mdx index e399c142ee..6a4edaea36 100644 --- a/Docs/src/content/docs/br/development/Server/Guide/centrifugo-running-environment.mdx +++ b/Docs/src/content/docs/br/development/Server/Guide/centrifugo-running-environment.mdx @@ -21,22 +21,42 @@ The majority of the setup should already be done based on the parent Getting Sta In the main directory, there is a `centrifugo-config.json`. -Ensure that in `allowed_origins` that the value in `config.open.publicUrl` is the array value.\ -Ensure that in `proxy_connect_endpoint` and `proxy_subscribe_endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ -The value for `proxy_subscribe` should also be `true`. +Ensure that in `client.allowed_origins` that the value in `config.open.publicUrl` is the array value.\ +Ensure that in `client.proxy.connect.endpoint` and `channel.proxy.subscribe.endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ +The value for `channel.namespaces[...].subscribe_proxy_enabled` should also be `true`. For example, if my `config.open.publicUrl` was `http://localhost:7000`, and my `config.api.publicUrl` was `http://localhost:8080`, then my `centrifugo-config.json` would look like this: ```json { ..., - "allowed_origins": [..., "http://localhost:7000", ...], + "client": { + ..., + "allowed_origins": [..., "http://localhost:7000", ...], + "proxy": { + "connect": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", + ... + } + } + }, ..., - "proxy_connect_endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", - ..., - "proxy_subscribe_endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", - ..., - "proxy_subscribe": true + "channel": { + "proxy": { + "subscribe": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", + ... + } + }, + "namespaces": [ + { + "name": "matchup", + "subscribe_proxy_enabled": true, + ... + }, + ... + ], + ... } ``` @@ -54,7 +74,7 @@ In the console, there should be no errors when running. This is only for if the above doesn't work, which can happen in Windows/WSL. -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ Afterwards, go to `scripts.centrifugo:local` in `package.json` located in the parent directory, and ensure it has the same port listed in `config.centrifugo.publicUrl` and `config.centrifugo.apiUrl`. Once done, it should run using the following command diff --git a/Docs/src/content/docs/br/development/index.mdx b/Docs/src/content/docs/br/development/index.mdx index 86a8e71e21..a438f27d00 100644 --- a/Docs/src/content/docs/br/development/index.mdx +++ b/Docs/src/content/docs/br/development/index.mdx @@ -70,7 +70,7 @@ Os valores no seu arquivo de configuração pessoal `config/user/$USER.json` ser :::note - Appearance > Advanced > Developer Mode @@ -130,7 +130,8 @@ Create a "staff" role and give it to yourself. Right-click your server name and "Copy ID". Paste this into `config.discord.guild`. -Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR paste that role ID into the following config values to give yourself god-tier permissions. +Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR +paste that role ID into the following config values to give yourself god-tier permissions. ``` config.discord.roles.corsace.corsace @@ -177,7 +178,7 @@ Follow this link to add your bot to your server. ###### Bot -Head to the Bot section of the bot and copy your bot token. +Head to the Bot section of the bot and copy your bot token. Paste it into `config.discord.token` Ensure you enable the `Server Members` and `Message Content` intents under the **Privileged Gateway Intents** subsection before usage, the bot will not start otherwise, and you will be provided a `[DISALLOWED INTENTS]` error. @@ -213,13 +214,13 @@ O banco de dados estará acessível em `127.0.0.1:3306`, e o nome do banco de da ##### Configuração Manual do MariaDB -Se você não deseja usar o Docker, precisará instalar o [MariaDB](https://mariadb.org/) e criar um banco de dados vazio, com o nome que desejar. +Se você não deseja usar o Docker, precisará instalar o [MariaDB](https://mariadb.org/) e criar um banco de dados vazio, com o nome que desejar. Pode ser tão simples quanto executar: ```bash mysql -u root -p -MySQL> create database ; +MySQL> create database ; ``` Certifique-se de atualizar `config.database` para refletir sua escolha de nome e credenciais do banco de dados. @@ -238,7 +239,7 @@ Usamos três buckets: - `team-avatars` é um bucket público que armazena avatares de equipe e pode ser servido por um CDN sem autenticação; - `mappacks` é um bucket público que armazena mappacks públicos e pode ser servido por um CDN sem autenticação; -- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access +- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access Generated mappacks are first uploaded to this bucket, users are given access through pre-signed URLs. @@ -268,7 +269,8 @@ We use Centrifugo for real-time notifications. You can find the documentation [h On Unix: Run `npm run centrifugo` to start the centrifugo server. It will be available at `http://localhost:8001` by default, unless you change the port in the config files. -On WSL/Windows OR if the above doesn't work: Install the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. +On WSL/Windows OR if the above doesn't work: +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. Afterwards, run `npm run centrifugo:local` to start the centrifugo server. If you want to change the port, change the `-p` flag in the repective script in `package.json`, and your config file's api URL. :::note diff --git a/Docs/src/content/docs/cn/development/Client/Guide/docs-write-edit-documents.mdx b/Docs/src/content/docs/cn/development/Client/Guide/docs-write-edit-documents.mdx index 7c3725e178..72bd29da8e 100644 --- a/Docs/src/content/docs/cn/development/Client/Guide/docs-write-edit-documents.mdx +++ b/Docs/src/content/docs/cn/development/Client/Guide/docs-write-edit-documents.mdx @@ -26,7 +26,6 @@ import WorkInProgress from '../../../../../../components/WorkInProgress.astro'; 其中的文件夹结构类似于网站上侧边栏的层次结构。\ 总的来看，有三个主要部分： -* [设计文档](design) * [开发文档](development) * [如何在 Corsace 运行比赛的文档](tournaments) * [Documentation on playing in tournaments run via Corsace](../../../../tournament_play) diff --git a/Docs/src/content/docs/cn/development/Server/Guide/centrifugo-running-environment.mdx b/Docs/src/content/docs/cn/development/Server/Guide/centrifugo-running-environment.mdx index e399c142ee..6a4edaea36 100644 --- a/Docs/src/content/docs/cn/development/Server/Guide/centrifugo-running-environment.mdx +++ b/Docs/src/content/docs/cn/development/Server/Guide/centrifugo-running-environment.mdx @@ -21,22 +21,42 @@ The majority of the setup should already be done based on the parent Getting Sta In the main directory, there is a `centrifugo-config.json`. -Ensure that in `allowed_origins` that the value in `config.open.publicUrl` is the array value.\ -Ensure that in `proxy_connect_endpoint` and `proxy_subscribe_endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ -The value for `proxy_subscribe` should also be `true`. +Ensure that in `client.allowed_origins` that the value in `config.open.publicUrl` is the array value.\ +Ensure that in `client.proxy.connect.endpoint` and `channel.proxy.subscribe.endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ +The value for `channel.namespaces[...].subscribe_proxy_enabled` should also be `true`. For example, if my `config.open.publicUrl` was `http://localhost:7000`, and my `config.api.publicUrl` was `http://localhost:8080`, then my `centrifugo-config.json` would look like this: ```json { ..., - "allowed_origins": [..., "http://localhost:7000", ...], + "client": { + ..., + "allowed_origins": [..., "http://localhost:7000", ...], + "proxy": { + "connect": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", + ... + } + } + }, ..., - "proxy_connect_endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", - ..., - "proxy_subscribe_endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", - ..., - "proxy_subscribe": true + "channel": { + "proxy": { + "subscribe": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", + ... + } + }, + "namespaces": [ + { + "name": "matchup", + "subscribe_proxy_enabled": true, + ... + }, + ... + ], + ... } ``` @@ -54,7 +74,7 @@ In the console, there should be no errors when running. This is only for if the above doesn't work, which can happen in Windows/WSL. -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ Afterwards, go to `scripts.centrifugo:local` in `package.json` located in the parent directory, and ensure it has the same port listed in `config.centrifugo.publicUrl` and `config.centrifugo.apiUrl`. Once done, it should run using the following command diff --git a/Docs/src/content/docs/cn/development/index.mdx b/Docs/src/content/docs/cn/development/index.mdx index c6e674f652..e4d00f5155 100644 --- a/Docs/src/content/docs/cn/development/index.mdx +++ b/Docs/src/content/docs/cn/development/index.mdx @@ -70,7 +70,7 @@ The values in your personal `config/user/$USER.json` config file will be referre :::note - Appearance > Advanced > Developer Mode @@ -130,7 +130,7 @@ Create a "staff" role and give it to yourself. Right-click your server name and "Copy ID". Paste this into `config.discord.guild`. -Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR +Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR paste that role ID into the following config values to give yourself god-tier permissions. ``` @@ -178,7 +178,7 @@ Follow this link to add your bot to your server. ###### Bot -Head to the `Bot` section of the Discord application and copy your bot token. +Head to the `Bot` section of the Discord application and copy your bot token. Paste it into `config.discord.token` Ensure you enable the `Server Members` and `Message Content` intents under the **Privileged Gateway Intents** subsection before usage, the bot will not start otherwise, and you will be provided a `[DISALLOWED INTENTS]` error. @@ -214,13 +214,13 @@ The database will listen on `127.0.0.1:3306`, with `corsace` being the database ##### Manual MariaDB Setup -If you do not want to use Docker, you will need to install [MariaDB](https://mariadb.org/) and create an empty database, named whatever you like. +If you do not want to use Docker, you will need to install [MariaDB](https://mariadb.org/) and create an empty database, named whatever you like. It can be as simple as running: ```bash mysql -u root -p -MySQL> create database ; +MySQL> create database ; ``` Make sure to update `config.database` to reflect your choice of database name and credentials. @@ -239,7 +239,7 @@ We use three buckets: - `team-avatars` is a public bucket that stores team avatars, can be served by a CDN without authentication - `mappacks` is a public bucket that stores public mappacks, can be served by a CDN without authentication -- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access +- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access Generated mappacks are first uploaded to this bucket, users are given access through pre-signed URLs. @@ -267,7 +267,7 @@ On Unix: Run `npm run centrifugo` to start the centrifugo server. It will be available at `http://localhost:8001` by default, unless you change the port in the config files. On WSL/Windows OR if the above doesn't work: -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. Afterwards, run `npm run centrifugo:local` to start the centrifugo server. If you want to change the port, change the `-p` flag in the respective script in `package.json`, and your config file's api URL. :::note diff --git a/Docs/src/content/docs/de/development/Client/Guide/docs-write-edit-documents.mdx b/Docs/src/content/docs/de/development/Client/Guide/docs-write-edit-documents.mdx index 2c6d50989d..b56358fe17 100644 --- a/Docs/src/content/docs/de/development/Client/Guide/docs-write-edit-documents.mdx +++ b/Docs/src/content/docs/de/development/Client/Guide/docs-write-edit-documents.mdx @@ -26,7 +26,6 @@ For any document you wish to create, it must reside somewhere within `Docs/src/c The folder structure within this is similar to the sidebar's hierarchy on the website.\ Primarily, there are 3 main sections: -* [Design Documentation](design) * [Development Documentation](development) * [Documentation on how to run tournaments via Corsace](tournaments) * [Documentation on playing in tournaments run via Corsace](../../../../tournament_play) @@ -78,7 +77,7 @@ If your documentation is dependant on any other documents within this repository ### Images -Images should be put in the `Docs/src/images` directory. +Images should be put in the `Docs/src/images` directory. Images should be put in the `Docs/src/images` directory. To access an image in `Assets/img/docs` from this file (which is at `Docs/src/content/docs/en/development/Client/Guide/docs-write-edit-documents.mdx`), you require the following relative direction: ```mdx diff --git a/Docs/src/content/docs/de/development/Server/Guide/centrifugo-running-environment.mdx b/Docs/src/content/docs/de/development/Server/Guide/centrifugo-running-environment.mdx index e399c142ee..6a4edaea36 100644 --- a/Docs/src/content/docs/de/development/Server/Guide/centrifugo-running-environment.mdx +++ b/Docs/src/content/docs/de/development/Server/Guide/centrifugo-running-environment.mdx @@ -21,22 +21,42 @@ The majority of the setup should already be done based on the parent Getting Sta In the main directory, there is a `centrifugo-config.json`. -Ensure that in `allowed_origins` that the value in `config.open.publicUrl` is the array value.\ -Ensure that in `proxy_connect_endpoint` and `proxy_subscribe_endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ -The value for `proxy_subscribe` should also be `true`. +Ensure that in `client.allowed_origins` that the value in `config.open.publicUrl` is the array value.\ +Ensure that in `client.proxy.connect.endpoint` and `channel.proxy.subscribe.endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ +The value for `channel.namespaces[...].subscribe_proxy_enabled` should also be `true`. For example, if my `config.open.publicUrl` was `http://localhost:7000`, and my `config.api.publicUrl` was `http://localhost:8080`, then my `centrifugo-config.json` would look like this: ```json { ..., - "allowed_origins": [..., "http://localhost:7000", ...], + "client": { + ..., + "allowed_origins": [..., "http://localhost:7000", ...], + "proxy": { + "connect": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", + ... + } + } + }, ..., - "proxy_connect_endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", - ..., - "proxy_subscribe_endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", - ..., - "proxy_subscribe": true + "channel": { + "proxy": { + "subscribe": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", + ... + } + }, + "namespaces": [ + { + "name": "matchup", + "subscribe_proxy_enabled": true, + ... + }, + ... + ], + ... } ``` @@ -54,7 +74,7 @@ In the console, there should be no errors when running. This is only for if the above doesn't work, which can happen in Windows/WSL. -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ Afterwards, go to `scripts.centrifugo:local` in `package.json` located in the parent directory, and ensure it has the same port listed in `config.centrifugo.publicUrl` and `config.centrifugo.apiUrl`. Once done, it should run using the following command diff --git a/Docs/src/content/docs/de/development/index.mdx b/Docs/src/content/docs/de/development/index.mdx index e0dad99ecf..5fbc4d47c2 100644 --- a/Docs/src/content/docs/de/development/index.mdx +++ b/Docs/src/content/docs/de/development/index.mdx @@ -70,7 +70,7 @@ The values in your personal `config/user/$USER.json` config file will be referre :::note - Appearance > Advanced > Developer Mode @@ -130,7 +130,7 @@ Create a "staff" role and give it to yourself. Right-click your server name and "Copy ID". Paste this into `config.discord.guild`. -Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR +Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR paste that role ID into the following config values to give yourself god-tier permissions. ``` @@ -178,7 +178,7 @@ Follow this link to add your bot to your server. ###### Bot -Head to the `Bot` section of the Discord application and copy your bot token. +Head to the `Bot` section of the Discord application and copy your bot token. Paste it into `config.discord.token` Ensure you enable the `Server Members` and `Message Content` intents under the **Privileged Gateway Intents** subsection before usage, the bot will not start otherwise, and you will be provided a `[DISALLOWED INTENTS]` error. @@ -214,13 +214,13 @@ The database will listen on `127.0.0.1:3306`, with `corsace` being the database ##### Manual MariaDB Setup -If you do not want to use Docker, you will need to install [MariaDB](https://mariadb.org/) and create an empty database, named whatever you like. +If you do not want to use Docker, you will need to install [MariaDB](https://mariadb.org/) and create an empty database, named whatever you like. It can be as simple as running: ```bash mysql -u root -p -MySQL> create database ; +MySQL> create database ; ``` Make sure to update `config.database` to reflect your choice of database name and credentials. @@ -239,7 +239,7 @@ We use three buckets: - `team-avatars` is a public bucket that stores team avatars, can be served by a CDN without authentication - `mappacks` is a public bucket that stores public mappacks, can be served by a CDN without authentication -- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access +- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access Generated mappacks are first uploaded to this bucket, users are given access through pre-signed URLs. @@ -267,7 +267,7 @@ On Unix: Run `npm run centrifugo` to start the centrifugo server. It will be available at `http://localhost:8001` by default, unless you change the port in the config files. On WSL/Windows OR if the above doesn't work: -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. Afterwards, run `npm run centrifugo:local` to start the centrifugo server. If you want to change the port, change the `-p` flag in the respective script in `package.json`, and your config file's api URL. :::note diff --git a/Docs/src/content/docs/es/development/Client/Guide/docs-write-edit-documents.mdx b/Docs/src/content/docs/es/development/Client/Guide/docs-write-edit-documents.mdx index fa478ba8ce..7451b28a80 100644 --- a/Docs/src/content/docs/es/development/Client/Guide/docs-write-edit-documents.mdx +++ b/Docs/src/content/docs/es/development/Client/Guide/docs-write-edit-documents.mdx @@ -26,7 +26,6 @@ For any document you wish to create, it must reside somewhere within `Docs/src/c The folder structure within this is similar to the sidebar's hierarchy on the website.\ Primarily, there are 3 main sections: -* [Design Documentation](../../../../design) * [Development Documentation](../../../../development) * [Documentation on how to run tournaments via Corsace](../../../../tournament_org) * [Documentation on playing in tournaments run via Corsace](../../../../tournament_play) diff --git a/Docs/src/content/docs/es/development/Server/Guide/centrifugo-running-environment.mdx b/Docs/src/content/docs/es/development/Server/Guide/centrifugo-running-environment.mdx index e399c142ee..6a4edaea36 100644 --- a/Docs/src/content/docs/es/development/Server/Guide/centrifugo-running-environment.mdx +++ b/Docs/src/content/docs/es/development/Server/Guide/centrifugo-running-environment.mdx @@ -21,22 +21,42 @@ The majority of the setup should already be done based on the parent Getting Sta In the main directory, there is a `centrifugo-config.json`. -Ensure that in `allowed_origins` that the value in `config.open.publicUrl` is the array value.\ -Ensure that in `proxy_connect_endpoint` and `proxy_subscribe_endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ -The value for `proxy_subscribe` should also be `true`. +Ensure that in `client.allowed_origins` that the value in `config.open.publicUrl` is the array value.\ +Ensure that in `client.proxy.connect.endpoint` and `channel.proxy.subscribe.endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ +The value for `channel.namespaces[...].subscribe_proxy_enabled` should also be `true`. For example, if my `config.open.publicUrl` was `http://localhost:7000`, and my `config.api.publicUrl` was `http://localhost:8080`, then my `centrifugo-config.json` would look like this: ```json { ..., - "allowed_origins": [..., "http://localhost:7000", ...], + "client": { + ..., + "allowed_origins": [..., "http://localhost:7000", ...], + "proxy": { + "connect": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", + ... + } + } + }, ..., - "proxy_connect_endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", - ..., - "proxy_subscribe_endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", - ..., - "proxy_subscribe": true + "channel": { + "proxy": { + "subscribe": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", + ... + } + }, + "namespaces": [ + { + "name": "matchup", + "subscribe_proxy_enabled": true, + ... + }, + ... + ], + ... } ``` @@ -54,7 +74,7 @@ In the console, there should be no errors when running. This is only for if the above doesn't work, which can happen in Windows/WSL. -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ Afterwards, go to `scripts.centrifugo:local` in `package.json` located in the parent directory, and ensure it has the same port listed in `config.centrifugo.publicUrl` and `config.centrifugo.apiUrl`. Once done, it should run using the following command diff --git a/Docs/src/content/docs/es/development/index.mdx b/Docs/src/content/docs/es/development/index.mdx index e0dad99ecf..5fbc4d47c2 100644 --- a/Docs/src/content/docs/es/development/index.mdx +++ b/Docs/src/content/docs/es/development/index.mdx @@ -70,7 +70,7 @@ The values in your personal `config/user/$USER.json` config file will be referre :::note - Appearance > Advanced > Developer Mode @@ -130,7 +130,7 @@ Create a "staff" role and give it to yourself. Right-click your server name and "Copy ID". Paste this into `config.discord.guild`. -Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR +Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR paste that role ID into the following config values to give yourself god-tier permissions. ``` @@ -178,7 +178,7 @@ Follow this link to add your bot to your server. ###### Bot -Head to the `Bot` section of the Discord application and copy your bot token. +Head to the `Bot` section of the Discord application and copy your bot token. Paste it into `config.discord.token` Ensure you enable the `Server Members` and `Message Content` intents under the **Privileged Gateway Intents** subsection before usage, the bot will not start otherwise, and you will be provided a `[DISALLOWED INTENTS]` error. @@ -214,13 +214,13 @@ The database will listen on `127.0.0.1:3306`, with `corsace` being the database ##### Manual MariaDB Setup -If you do not want to use Docker, you will need to install [MariaDB](https://mariadb.org/) and create an empty database, named whatever you like. +If you do not want to use Docker, you will need to install [MariaDB](https://mariadb.org/) and create an empty database, named whatever you like. It can be as simple as running: ```bash mysql -u root -p -MySQL> create database ; +MySQL> create database ; ``` Make sure to update `config.database` to reflect your choice of database name and credentials. @@ -239,7 +239,7 @@ We use three buckets: - `team-avatars` is a public bucket that stores team avatars, can be served by a CDN without authentication - `mappacks` is a public bucket that stores public mappacks, can be served by a CDN without authentication -- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access +- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access Generated mappacks are first uploaded to this bucket, users are given access through pre-signed URLs. @@ -267,7 +267,7 @@ On Unix: Run `npm run centrifugo` to start the centrifugo server. It will be available at `http://localhost:8001` by default, unless you change the port in the config files. On WSL/Windows OR if the above doesn't work: -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. Afterwards, run `npm run centrifugo:local` to start the centrifugo server. If you want to change the port, change the `-p` flag in the respective script in `package.json`, and your config file's api URL. :::note diff --git a/Docs/src/content/docs/fr/development/Client/Guide/docs-write-edit-documents.mdx b/Docs/src/content/docs/fr/development/Client/Guide/docs-write-edit-documents.mdx index fa478ba8ce..7451b28a80 100644 --- a/Docs/src/content/docs/fr/development/Client/Guide/docs-write-edit-documents.mdx +++ b/Docs/src/content/docs/fr/development/Client/Guide/docs-write-edit-documents.mdx @@ -26,7 +26,6 @@ For any document you wish to create, it must reside somewhere within `Docs/src/c The folder structure within this is similar to the sidebar's hierarchy on the website.\ Primarily, there are 3 main sections: -* [Design Documentation](../../../../design) * [Development Documentation](../../../../development) * [Documentation on how to run tournaments via Corsace](../../../../tournament_org) * [Documentation on playing in tournaments run via Corsace](../../../../tournament_play) diff --git a/Docs/src/content/docs/fr/development/Server/Guide/centrifugo-running-environment.mdx b/Docs/src/content/docs/fr/development/Server/Guide/centrifugo-running-environment.mdx index e399c142ee..6a4edaea36 100644 --- a/Docs/src/content/docs/fr/development/Server/Guide/centrifugo-running-environment.mdx +++ b/Docs/src/content/docs/fr/development/Server/Guide/centrifugo-running-environment.mdx @@ -21,22 +21,42 @@ The majority of the setup should already be done based on the parent Getting Sta In the main directory, there is a `centrifugo-config.json`. -Ensure that in `allowed_origins` that the value in `config.open.publicUrl` is the array value.\ -Ensure that in `proxy_connect_endpoint` and `proxy_subscribe_endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ -The value for `proxy_subscribe` should also be `true`. +Ensure that in `client.allowed_origins` that the value in `config.open.publicUrl` is the array value.\ +Ensure that in `client.proxy.connect.endpoint` and `channel.proxy.subscribe.endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ +The value for `channel.namespaces[...].subscribe_proxy_enabled` should also be `true`. For example, if my `config.open.publicUrl` was `http://localhost:7000`, and my `config.api.publicUrl` was `http://localhost:8080`, then my `centrifugo-config.json` would look like this: ```json { ..., - "allowed_origins": [..., "http://localhost:7000", ...], + "client": { + ..., + "allowed_origins": [..., "http://localhost:7000", ...], + "proxy": { + "connect": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", + ... + } + } + }, ..., - "proxy_connect_endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", - ..., - "proxy_subscribe_endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", - ..., - "proxy_subscribe": true + "channel": { + "proxy": { + "subscribe": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", + ... + } + }, + "namespaces": [ + { + "name": "matchup", + "subscribe_proxy_enabled": true, + ... + }, + ... + ], + ... } ``` @@ -54,7 +74,7 @@ In the console, there should be no errors when running. This is only for if the above doesn't work, which can happen in Windows/WSL. -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ Afterwards, go to `scripts.centrifugo:local` in `package.json` located in the parent directory, and ensure it has the same port listed in `config.centrifugo.publicUrl` and `config.centrifugo.apiUrl`. Once done, it should run using the following command diff --git a/Docs/src/content/docs/fr/development/index.mdx b/Docs/src/content/docs/fr/development/index.mdx index e0dad99ecf..5fbc4d47c2 100644 --- a/Docs/src/content/docs/fr/development/index.mdx +++ b/Docs/src/content/docs/fr/development/index.mdx @@ -70,7 +70,7 @@ The values in your personal `config/user/$USER.json` config file will be referre :::note - Appearance > Advanced > Developer Mode @@ -130,7 +130,7 @@ Create a "staff" role and give it to yourself. Right-click your server name and "Copy ID". Paste this into `config.discord.guild`. -Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR +Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR paste that role ID into the following config values to give yourself god-tier permissions. ``` @@ -178,7 +178,7 @@ Follow this link to add your bot to your server. ###### Bot -Head to the `Bot` section of the Discord application and copy your bot token. +Head to the `Bot` section of the Discord application and copy your bot token. Paste it into `config.discord.token` Ensure you enable the `Server Members` and `Message Content` intents under the **Privileged Gateway Intents** subsection before usage, the bot will not start otherwise, and you will be provided a `[DISALLOWED INTENTS]` error. @@ -214,13 +214,13 @@ The database will listen on `127.0.0.1:3306`, with `corsace` being the database ##### Manual MariaDB Setup -If you do not want to use Docker, you will need to install [MariaDB](https://mariadb.org/) and create an empty database, named whatever you like. +If you do not want to use Docker, you will need to install [MariaDB](https://mariadb.org/) and create an empty database, named whatever you like. It can be as simple as running: ```bash mysql -u root -p -MySQL> create database ; +MySQL> create database ; ``` Make sure to update `config.database` to reflect your choice of database name and credentials. @@ -239,7 +239,7 @@ We use three buckets: - `team-avatars` is a public bucket that stores team avatars, can be served by a CDN without authentication - `mappacks` is a public bucket that stores public mappacks, can be served by a CDN without authentication -- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access +- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access Generated mappacks are first uploaded to this bucket, users are given access through pre-signed URLs. @@ -267,7 +267,7 @@ On Unix: Run `npm run centrifugo` to start the centrifugo server. It will be available at `http://localhost:8001` by default, unless you change the port in the config files. On WSL/Windows OR if the above doesn't work: -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. Afterwards, run `npm run centrifugo:local` to start the centrifugo server. If you want to change the port, change the `-p` flag in the respective script in `package.json`, and your config file's api URL. :::note diff --git a/Docs/src/content/docs/gr/development/Client/Guide/docs-write-edit-documents.mdx b/Docs/src/content/docs/gr/development/Client/Guide/docs-write-edit-documents.mdx index 59ff7529d2..e8541b1d1b 100644 --- a/Docs/src/content/docs/gr/development/Client/Guide/docs-write-edit-documents.mdx +++ b/Docs/src/content/docs/gr/development/Client/Guide/docs-write-edit-documents.mdx @@ -26,7 +26,6 @@ For any document you wish to create, it must reside somewhere within `Docs/src/c The folder structure within this is similar to the sidebar's hierarchy on the website.\ Primarily, there are 3 main sections: -* [Design Documentation](design) * [Development Documentation](development) * [Documentation on how to run tournaments via Corsace](tournaments) * [Documentation on playing in tournaments run via Corsace](../../../../tournament_play) diff --git a/Docs/src/content/docs/gr/development/Server/Guide/centrifugo-running-environment.mdx b/Docs/src/content/docs/gr/development/Server/Guide/centrifugo-running-environment.mdx index e399c142ee..6a4edaea36 100644 --- a/Docs/src/content/docs/gr/development/Server/Guide/centrifugo-running-environment.mdx +++ b/Docs/src/content/docs/gr/development/Server/Guide/centrifugo-running-environment.mdx @@ -21,22 +21,42 @@ The majority of the setup should already be done based on the parent Getting Sta In the main directory, there is a `centrifugo-config.json`. -Ensure that in `allowed_origins` that the value in `config.open.publicUrl` is the array value.\ -Ensure that in `proxy_connect_endpoint` and `proxy_subscribe_endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ -The value for `proxy_subscribe` should also be `true`. +Ensure that in `client.allowed_origins` that the value in `config.open.publicUrl` is the array value.\ +Ensure that in `client.proxy.connect.endpoint` and `channel.proxy.subscribe.endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ +The value for `channel.namespaces[...].subscribe_proxy_enabled` should also be `true`. For example, if my `config.open.publicUrl` was `http://localhost:7000`, and my `config.api.publicUrl` was `http://localhost:8080`, then my `centrifugo-config.json` would look like this: ```json { ..., - "allowed_origins": [..., "http://localhost:7000", ...], + "client": { + ..., + "allowed_origins": [..., "http://localhost:7000", ...], + "proxy": { + "connect": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", + ... + } + } + }, ..., - "proxy_connect_endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", - ..., - "proxy_subscribe_endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", - ..., - "proxy_subscribe": true + "channel": { + "proxy": { + "subscribe": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", + ... + } + }, + "namespaces": [ + { + "name": "matchup", + "subscribe_proxy_enabled": true, + ... + }, + ... + ], + ... } ``` @@ -54,7 +74,7 @@ In the console, there should be no errors when running. This is only for if the above doesn't work, which can happen in Windows/WSL. -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ Afterwards, go to `scripts.centrifugo:local` in `package.json` located in the parent directory, and ensure it has the same port listed in `config.centrifugo.publicUrl` and `config.centrifugo.apiUrl`. Once done, it should run using the following command diff --git a/Docs/src/content/docs/gr/development/index.mdx b/Docs/src/content/docs/gr/development/index.mdx index e0dad99ecf..5fbc4d47c2 100644 --- a/Docs/src/content/docs/gr/development/index.mdx +++ b/Docs/src/content/docs/gr/development/index.mdx @@ -70,7 +70,7 @@ The values in your personal `config/user/$USER.json` config file will be referre :::note - Appearance > Advanced > Developer Mode @@ -130,7 +130,7 @@ Create a "staff" role and give it to yourself. Right-click your server name and "Copy ID". Paste this into `config.discord.guild`. -Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR +Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR paste that role ID into the following config values to give yourself god-tier permissions. ``` @@ -178,7 +178,7 @@ Follow this link to add your bot to your server. ###### Bot -Head to the `Bot` section of the Discord application and copy your bot token. +Head to the `Bot` section of the Discord application and copy your bot token. Paste it into `config.discord.token` Ensure you enable the `Server Members` and `Message Content` intents under the **Privileged Gateway Intents** subsection before usage, the bot will not start otherwise, and you will be provided a `[DISALLOWED INTENTS]` error. @@ -214,13 +214,13 @@ The database will listen on `127.0.0.1:3306`, with `corsace` being the database ##### Manual MariaDB Setup -If you do not want to use Docker, you will need to install [MariaDB](https://mariadb.org/) and create an empty database, named whatever you like. +If you do not want to use Docker, you will need to install [MariaDB](https://mariadb.org/) and create an empty database, named whatever you like. It can be as simple as running: ```bash mysql -u root -p -MySQL> create database ; +MySQL> create database ; ``` Make sure to update `config.database` to reflect your choice of database name and credentials. @@ -239,7 +239,7 @@ We use three buckets: - `team-avatars` is a public bucket that stores team avatars, can be served by a CDN without authentication - `mappacks` is a public bucket that stores public mappacks, can be served by a CDN without authentication -- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access +- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access Generated mappacks are first uploaded to this bucket, users are given access through pre-signed URLs. @@ -267,7 +267,7 @@ On Unix: Run `npm run centrifugo` to start the centrifugo server. It will be available at `http://localhost:8001` by default, unless you change the port in the config files. On WSL/Windows OR if the above doesn't work: -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. Afterwards, run `npm run centrifugo:local` to start the centrifugo server. If you want to change the port, change the `-p` flag in the respective script in `package.json`, and your config file's api URL. :::note diff --git a/Docs/src/content/docs/id/development/Client/Guide/docs-write-edit-documents.mdx b/Docs/src/content/docs/id/development/Client/Guide/docs-write-edit-documents.mdx index 379297c207..f68bfd92e4 100644 --- a/Docs/src/content/docs/id/development/Client/Guide/docs-write-edit-documents.mdx +++ b/Docs/src/content/docs/id/development/Client/Guide/docs-write-edit-documents.mdx @@ -26,7 +26,6 @@ Dokumen yang akan kamu buat harus ditempatkan pada `Docs/src/content/docs/en` at Struktur direktori yang dimiliki oleh folder ini serupa dengan struktur direktori yang tertera pada sidebar.\ Secara garis besar, dokumentasi proyek ini terbagi menjadi 3 bagian utama: -* [Dokumentasi Desain](design) * [Dokumentasi Pengembangan](development) * [Dokumentasi cara menjalankan turnamen melalui Corsace](tournaments) * [Documentation on playing in tournaments run via Corsace](../../../../tournament_play) diff --git a/Docs/src/content/docs/id/development/Server/Guide/centrifugo-running-environment.mdx b/Docs/src/content/docs/id/development/Server/Guide/centrifugo-running-environment.mdx index e399c142ee..6a4edaea36 100644 --- a/Docs/src/content/docs/id/development/Server/Guide/centrifugo-running-environment.mdx +++ b/Docs/src/content/docs/id/development/Server/Guide/centrifugo-running-environment.mdx @@ -21,22 +21,42 @@ The majority of the setup should already be done based on the parent Getting Sta In the main directory, there is a `centrifugo-config.json`. -Ensure that in `allowed_origins` that the value in `config.open.publicUrl` is the array value.\ -Ensure that in `proxy_connect_endpoint` and `proxy_subscribe_endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ -The value for `proxy_subscribe` should also be `true`. +Ensure that in `client.allowed_origins` that the value in `config.open.publicUrl` is the array value.\ +Ensure that in `client.proxy.connect.endpoint` and `channel.proxy.subscribe.endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ +The value for `channel.namespaces[...].subscribe_proxy_enabled` should also be `true`. For example, if my `config.open.publicUrl` was `http://localhost:7000`, and my `config.api.publicUrl` was `http://localhost:8080`, then my `centrifugo-config.json` would look like this: ```json { ..., - "allowed_origins": [..., "http://localhost:7000", ...], + "client": { + ..., + "allowed_origins": [..., "http://localhost:7000", ...], + "proxy": { + "connect": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", + ... + } + } + }, ..., - "proxy_connect_endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", - ..., - "proxy_subscribe_endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", - ..., - "proxy_subscribe": true + "channel": { + "proxy": { + "subscribe": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", + ... + } + }, + "namespaces": [ + { + "name": "matchup", + "subscribe_proxy_enabled": true, + ... + }, + ... + ], + ... } ``` @@ -54,7 +74,7 @@ In the console, there should be no errors when running. This is only for if the above doesn't work, which can happen in Windows/WSL. -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ Afterwards, go to `scripts.centrifugo:local` in `package.json` located in the parent directory, and ensure it has the same port listed in `config.centrifugo.publicUrl` and `config.centrifugo.apiUrl`. Once done, it should run using the following command diff --git a/Docs/src/content/docs/id/development/index.mdx b/Docs/src/content/docs/id/development/index.mdx index 5038c82089..f895ab38ff 100644 --- a/Docs/src/content/docs/id/development/index.mdx +++ b/Docs/src/content/docs/id/development/index.mdx @@ -70,9 +70,9 @@ Ke depannya, dokumentasi ini akan merujuk pada nilai `config/user/$USER.json` pe :::note - ::: @@ -110,12 +110,12 @@ Apabila kamu menggunakan akan osu! khusus bot, pastikan kamu mengatur nilai para #### Pengaturan -Langkah ini merupakan langkah pengaturan yang paling memakan waktu. +Langkah ini merupakan langkah pengaturan yang paling memakan waktu. Kamu akan memerlukan: ##### Developer Mode yang Aktif -Centang opsi yang terdapat pada +Centang opsi yang terdapat pada ``` User Settings > Appearance > Advanced > Developer Mode @@ -130,8 +130,8 @@ Buat role "staff" dan berikan role ini kepada dirimu sendiri. Klik kanan nama servermu dan pilih "Copy ID". Salin ID ini ke `config.discord.guild`. -Klik kanan nama servermu dan pilih "Copy ID". Kamu dapat membuat role untuk berbagai kebutuhan pada config, ATAU -kamu juga dapat menyalin ID role ini pada baris config berikut untuk memberikanmu kuasa penuh akan segala sesuatunya. +Klik kanan nama servermu dan pilih "Copy ID". You can either create a role for each corresponding role in the config, OR +paste that role ID into the following config values to give yourself god-tier permissions. ``` config.discord.roles.corsace.corsace @@ -178,7 +178,7 @@ Ikuti tautan ini untuk menambahkan bot milikmu ke dalam server. ###### Bot -Tuju bagian Bot dan salin token bot milikmu. +Tuju bagian Bot dan salin token bot milikmu. Sisipkan token ini pada `config.discord.token`. Pastikan kamu telah mencentang `Server Members` dan `Message Content` pada daftar pilihan yang tersedia pada menu **Privileged Gateway Intents** sebelum memulai bot. Apabila tidak, bot kamu tidak akan berjalan dan kamu akan dihadapkan dengan pesan error `[DISALLOWED INTENTS]`. @@ -214,13 +214,13 @@ Database ini akan merespon permitaan pada `127.0.0.1:3306` dengan nama database, ##### Pengaturan MariaDB Manual -Apabila kamu tidak ingin menggunakan Docker, kamu akan perlu untuk mengistal [MariaDB](https://mariadb.org/) dan membuat database kosong yang dapat kamu namai sesuka hati. +Apabila kamu tidak ingin menggunakan Docker, kamu akan perlu untuk mengistal [MariaDB](https://mariadb.org/) dan membuat database kosong yang dapat kamu namai sesuka hati. Untuk membuat database ini, kamu hanya perlu untuk menjalankan: ```bash mysql -u root -p -MySQL> create database ; +MySQL> create database ; ``` Pastikan kamu memperbarui `config.database` dengan nama dan informasi kredensial database yang akan kamu gunakan. @@ -239,7 +239,7 @@ Kami menggunakan tiga bucket: - `team-avatars` merupakan bucket publik yang menyimpan avatar tim, yang dapat dilayani oleh CDN tanpa autentikasi - `mappacks` merupakan bucket publik yang menyimpan paket map publik, yang dapat dilayani oleh CDN tanpa autentikasi -- `mappacks-temp` merupakan bucket pribadi yang menyimpan paket beatmap privat yang tidak ditujukan untuk akses publik +- `mappacks-temp` merupakan bucket pribadi yang menyimpan paket beatmap privat yang tidak ditujukan untuk akses publik Paket beatmap yang dihasilkan akan terlebih dahulu diunggah ke bucket ini, di mana para pengguna akan kemudian diberikan akses melalui URL yang telah ditandatangani sebelumnya (pre-signed URL). @@ -266,8 +266,8 @@ Kami menggunakan Centrifugo untuk menampilkan notifikasi secara real-time. Kamu Pada Unix: Jalankan perintah `npm run centrifugo` untuk memulai server Centrifugo. Secara default, server ini akan tersedia pada `http://localhost:8001` selama kamu tidak mengubah nilai port pada berkas konfigurasi. -Pada WSL/Windows ATAU apabila metode di atas tidak bekerja: -Instal berkas biner (.exe) dari [daftar rilisan terbaru](https://github.com/centrifugal/centrifugo/releases) dan tambahkan ke folder root proyek ini. +On WSL/Windows OR if the above doesn't work: +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. Setelahnya, jalankan perintah `npm run centrifugo:local` untuk memulai server Centrifugo. Apabila kamu ingin mengubah nomor port yang digunakan, ubah nilai parameter '-p' pada script yang terkait di berkas `package.json` dan URL API config milikmu. :::note diff --git a/Docs/src/content/docs/it/development/Client/Guide/docs-write-edit-documents.mdx b/Docs/src/content/docs/it/development/Client/Guide/docs-write-edit-documents.mdx index 2c6d50989d..b56358fe17 100644 --- a/Docs/src/content/docs/it/development/Client/Guide/docs-write-edit-documents.mdx +++ b/Docs/src/content/docs/it/development/Client/Guide/docs-write-edit-documents.mdx @@ -26,7 +26,6 @@ For any document you wish to create, it must reside somewhere within `Docs/src/c The folder structure within this is similar to the sidebar's hierarchy on the website.\ Primarily, there are 3 main sections: -* [Design Documentation](design) * [Development Documentation](development) * [Documentation on how to run tournaments via Corsace](tournaments) * [Documentation on playing in tournaments run via Corsace](../../../../tournament_play) @@ -78,7 +77,7 @@ If your documentation is dependant on any other documents within this repository ### Images -Images should be put in the `Docs/src/images` directory. +Images should be put in the `Docs/src/images` directory. Images should be put in the `Docs/src/images` directory. To access an image in `Assets/img/docs` from this file (which is at `Docs/src/content/docs/en/development/Client/Guide/docs-write-edit-documents.mdx`), you require the following relative direction: ```mdx diff --git a/Docs/src/content/docs/it/development/Server/Guide/centrifugo-running-environment.mdx b/Docs/src/content/docs/it/development/Server/Guide/centrifugo-running-environment.mdx index e399c142ee..6a4edaea36 100644 --- a/Docs/src/content/docs/it/development/Server/Guide/centrifugo-running-environment.mdx +++ b/Docs/src/content/docs/it/development/Server/Guide/centrifugo-running-environment.mdx @@ -21,22 +21,42 @@ The majority of the setup should already be done based on the parent Getting Sta In the main directory, there is a `centrifugo-config.json`. -Ensure that in `allowed_origins` that the value in `config.open.publicUrl` is the array value.\ -Ensure that in `proxy_connect_endpoint` and `proxy_subscribe_endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ -The value for `proxy_subscribe` should also be `true`. +Ensure that in `client.allowed_origins` that the value in `config.open.publicUrl` is the array value.\ +Ensure that in `client.proxy.connect.endpoint` and `channel.proxy.subscribe.endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ +The value for `channel.namespaces[...].subscribe_proxy_enabled` should also be `true`. For example, if my `config.open.publicUrl` was `http://localhost:7000`, and my `config.api.publicUrl` was `http://localhost:8080`, then my `centrifugo-config.json` would look like this: ```json { ..., - "allowed_origins": [..., "http://localhost:7000", ...], + "client": { + ..., + "allowed_origins": [..., "http://localhost:7000", ...], + "proxy": { + "connect": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", + ... + } + } + }, ..., - "proxy_connect_endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", - ..., - "proxy_subscribe_endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", - ..., - "proxy_subscribe": true + "channel": { + "proxy": { + "subscribe": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", + ... + } + }, + "namespaces": [ + { + "name": "matchup", + "subscribe_proxy_enabled": true, + ... + }, + ... + ], + ... } ``` @@ -54,7 +74,7 @@ In the console, there should be no errors when running. This is only for if the above doesn't work, which can happen in Windows/WSL. -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ Afterwards, go to `scripts.centrifugo:local` in `package.json` located in the parent directory, and ensure it has the same port listed in `config.centrifugo.publicUrl` and `config.centrifugo.apiUrl`. Once done, it should run using the following command diff --git a/Docs/src/content/docs/it/development/index.mdx b/Docs/src/content/docs/it/development/index.mdx index e0dad99ecf..5fbc4d47c2 100644 --- a/Docs/src/content/docs/it/development/index.mdx +++ b/Docs/src/content/docs/it/development/index.mdx @@ -70,7 +70,7 @@ The values in your personal `config/user/$USER.json` config file will be referre :::note - Appearance > Advanced > Developer Mode @@ -130,7 +130,7 @@ Create a "staff" role and give it to yourself. Right-click your server name and "Copy ID". Paste this into `config.discord.guild`. -Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR +Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR paste that role ID into the following config values to give yourself god-tier permissions. ``` @@ -178,7 +178,7 @@ Follow this link to add your bot to your server. ###### Bot -Head to the `Bot` section of the Discord application and copy your bot token. +Head to the `Bot` section of the Discord application and copy your bot token. Paste it into `config.discord.token` Ensure you enable the `Server Members` and `Message Content` intents under the **Privileged Gateway Intents** subsection before usage, the bot will not start otherwise, and you will be provided a `[DISALLOWED INTENTS]` error. @@ -214,13 +214,13 @@ The database will listen on `127.0.0.1:3306`, with `corsace` being the database ##### Manual MariaDB Setup -If you do not want to use Docker, you will need to install [MariaDB](https://mariadb.org/) and create an empty database, named whatever you like. +If you do not want to use Docker, you will need to install [MariaDB](https://mariadb.org/) and create an empty database, named whatever you like. It can be as simple as running: ```bash mysql -u root -p -MySQL> create database ; +MySQL> create database ; ``` Make sure to update `config.database` to reflect your choice of database name and credentials. @@ -239,7 +239,7 @@ We use three buckets: - `team-avatars` is a public bucket that stores team avatars, can be served by a CDN without authentication - `mappacks` is a public bucket that stores public mappacks, can be served by a CDN without authentication -- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access +- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access Generated mappacks are first uploaded to this bucket, users are given access through pre-signed URLs. @@ -267,7 +267,7 @@ On Unix: Run `npm run centrifugo` to start the centrifugo server. It will be available at `http://localhost:8001` by default, unless you change the port in the config files. On WSL/Windows OR if the above doesn't work: -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. Afterwards, run `npm run centrifugo:local` to start the centrifugo server. If you want to change the port, change the `-p` flag in the respective script in `package.json`, and your config file's api URL. :::note diff --git a/Docs/src/content/docs/jp/development/Client/Guide/docs-write-edit-documents.mdx b/Docs/src/content/docs/jp/development/Client/Guide/docs-write-edit-documents.mdx index fa478ba8ce..7451b28a80 100644 --- a/Docs/src/content/docs/jp/development/Client/Guide/docs-write-edit-documents.mdx +++ b/Docs/src/content/docs/jp/development/Client/Guide/docs-write-edit-documents.mdx @@ -26,7 +26,6 @@ For any document you wish to create, it must reside somewhere within `Docs/src/c The folder structure within this is similar to the sidebar's hierarchy on the website.\ Primarily, there are 3 main sections: -* [Design Documentation](../../../../design) * [Development Documentation](../../../../development) * [Documentation on how to run tournaments via Corsace](../../../../tournament_org) * [Documentation on playing in tournaments run via Corsace](../../../../tournament_play) diff --git a/Docs/src/content/docs/jp/development/Server/Guide/centrifugo-running-environment.mdx b/Docs/src/content/docs/jp/development/Server/Guide/centrifugo-running-environment.mdx index e399c142ee..6a4edaea36 100644 --- a/Docs/src/content/docs/jp/development/Server/Guide/centrifugo-running-environment.mdx +++ b/Docs/src/content/docs/jp/development/Server/Guide/centrifugo-running-environment.mdx @@ -21,22 +21,42 @@ The majority of the setup should already be done based on the parent Getting Sta In the main directory, there is a `centrifugo-config.json`. -Ensure that in `allowed_origins` that the value in `config.open.publicUrl` is the array value.\ -Ensure that in `proxy_connect_endpoint` and `proxy_subscribe_endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ -The value for `proxy_subscribe` should also be `true`. +Ensure that in `client.allowed_origins` that the value in `config.open.publicUrl` is the array value.\ +Ensure that in `client.proxy.connect.endpoint` and `channel.proxy.subscribe.endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ +The value for `channel.namespaces[...].subscribe_proxy_enabled` should also be `true`. For example, if my `config.open.publicUrl` was `http://localhost:7000`, and my `config.api.publicUrl` was `http://localhost:8080`, then my `centrifugo-config.json` would look like this: ```json { ..., - "allowed_origins": [..., "http://localhost:7000", ...], + "client": { + ..., + "allowed_origins": [..., "http://localhost:7000", ...], + "proxy": { + "connect": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", + ... + } + } + }, ..., - "proxy_connect_endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", - ..., - "proxy_subscribe_endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", - ..., - "proxy_subscribe": true + "channel": { + "proxy": { + "subscribe": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", + ... + } + }, + "namespaces": [ + { + "name": "matchup", + "subscribe_proxy_enabled": true, + ... + }, + ... + ], + ... } ``` @@ -54,7 +74,7 @@ In the console, there should be no errors when running. This is only for if the above doesn't work, which can happen in Windows/WSL. -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ Afterwards, go to `scripts.centrifugo:local` in `package.json` located in the parent directory, and ensure it has the same port listed in `config.centrifugo.publicUrl` and `config.centrifugo.apiUrl`. Once done, it should run using the following command diff --git a/Docs/src/content/docs/jp/development/index.mdx b/Docs/src/content/docs/jp/development/index.mdx index e0dad99ecf..5fbc4d47c2 100644 --- a/Docs/src/content/docs/jp/development/index.mdx +++ b/Docs/src/content/docs/jp/development/index.mdx @@ -70,7 +70,7 @@ The values in your personal `config/user/$USER.json` config file will be referre :::note - Appearance > Advanced > Developer Mode @@ -130,7 +130,7 @@ Create a "staff" role and give it to yourself. Right-click your server name and "Copy ID". Paste this into `config.discord.guild`. -Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR +Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR paste that role ID into the following config values to give yourself god-tier permissions. ``` @@ -178,7 +178,7 @@ Follow this link to add your bot to your server. ###### Bot -Head to the `Bot` section of the Discord application and copy your bot token. +Head to the `Bot` section of the Discord application and copy your bot token. Paste it into `config.discord.token` Ensure you enable the `Server Members` and `Message Content` intents under the **Privileged Gateway Intents** subsection before usage, the bot will not start otherwise, and you will be provided a `[DISALLOWED INTENTS]` error. @@ -214,13 +214,13 @@ The database will listen on `127.0.0.1:3306`, with `corsace` being the database ##### Manual MariaDB Setup -If you do not want to use Docker, you will need to install [MariaDB](https://mariadb.org/) and create an empty database, named whatever you like. +If you do not want to use Docker, you will need to install [MariaDB](https://mariadb.org/) and create an empty database, named whatever you like. It can be as simple as running: ```bash mysql -u root -p -MySQL> create database ; +MySQL> create database ; ``` Make sure to update `config.database` to reflect your choice of database name and credentials. @@ -239,7 +239,7 @@ We use three buckets: - `team-avatars` is a public bucket that stores team avatars, can be served by a CDN without authentication - `mappacks` is a public bucket that stores public mappacks, can be served by a CDN without authentication -- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access +- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access Generated mappacks are first uploaded to this bucket, users are given access through pre-signed URLs. @@ -267,7 +267,7 @@ On Unix: Run `npm run centrifugo` to start the centrifugo server. It will be available at `http://localhost:8001` by default, unless you change the port in the config files. On WSL/Windows OR if the above doesn't work: -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. Afterwards, run `npm run centrifugo:local` to start the centrifugo server. If you want to change the port, change the `-p` flag in the respective script in `package.json`, and your config file's api URL. :::note diff --git a/Docs/src/content/docs/kr/development/Client/Guide/docs-write-edit-documents.mdx b/Docs/src/content/docs/kr/development/Client/Guide/docs-write-edit-documents.mdx index fa478ba8ce..7451b28a80 100644 --- a/Docs/src/content/docs/kr/development/Client/Guide/docs-write-edit-documents.mdx +++ b/Docs/src/content/docs/kr/development/Client/Guide/docs-write-edit-documents.mdx @@ -26,7 +26,6 @@ For any document you wish to create, it must reside somewhere within `Docs/src/c The folder structure within this is similar to the sidebar's hierarchy on the website.\ Primarily, there are 3 main sections: -* [Design Documentation](../../../../design) * [Development Documentation](../../../../development) * [Documentation on how to run tournaments via Corsace](../../../../tournament_org) * [Documentation on playing in tournaments run via Corsace](../../../../tournament_play) diff --git a/Docs/src/content/docs/kr/development/Server/Guide/centrifugo-running-environment.mdx b/Docs/src/content/docs/kr/development/Server/Guide/centrifugo-running-environment.mdx index e399c142ee..6a4edaea36 100644 --- a/Docs/src/content/docs/kr/development/Server/Guide/centrifugo-running-environment.mdx +++ b/Docs/src/content/docs/kr/development/Server/Guide/centrifugo-running-environment.mdx @@ -21,22 +21,42 @@ The majority of the setup should already be done based on the parent Getting Sta In the main directory, there is a `centrifugo-config.json`. -Ensure that in `allowed_origins` that the value in `config.open.publicUrl` is the array value.\ -Ensure that in `proxy_connect_endpoint` and `proxy_subscribe_endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ -The value for `proxy_subscribe` should also be `true`. +Ensure that in `client.allowed_origins` that the value in `config.open.publicUrl` is the array value.\ +Ensure that in `client.proxy.connect.endpoint` and `channel.proxy.subscribe.endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ +The value for `channel.namespaces[...].subscribe_proxy_enabled` should also be `true`. For example, if my `config.open.publicUrl` was `http://localhost:7000`, and my `config.api.publicUrl` was `http://localhost:8080`, then my `centrifugo-config.json` would look like this: ```json { ..., - "allowed_origins": [..., "http://localhost:7000", ...], + "client": { + ..., + "allowed_origins": [..., "http://localhost:7000", ...], + "proxy": { + "connect": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", + ... + } + } + }, ..., - "proxy_connect_endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", - ..., - "proxy_subscribe_endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", - ..., - "proxy_subscribe": true + "channel": { + "proxy": { + "subscribe": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", + ... + } + }, + "namespaces": [ + { + "name": "matchup", + "subscribe_proxy_enabled": true, + ... + }, + ... + ], + ... } ``` @@ -54,7 +74,7 @@ In the console, there should be no errors when running. This is only for if the above doesn't work, which can happen in Windows/WSL. -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ Afterwards, go to `scripts.centrifugo:local` in `package.json` located in the parent directory, and ensure it has the same port listed in `config.centrifugo.publicUrl` and `config.centrifugo.apiUrl`. Once done, it should run using the following command diff --git a/Docs/src/content/docs/kr/development/index.mdx b/Docs/src/content/docs/kr/development/index.mdx index e0dad99ecf..5fbc4d47c2 100644 --- a/Docs/src/content/docs/kr/development/index.mdx +++ b/Docs/src/content/docs/kr/development/index.mdx @@ -70,7 +70,7 @@ The values in your personal `config/user/$USER.json` config file will be referre :::note - Appearance > Advanced > Developer Mode @@ -130,7 +130,7 @@ Create a "staff" role and give it to yourself. Right-click your server name and "Copy ID". Paste this into `config.discord.guild`. -Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR +Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR paste that role ID into the following config values to give yourself god-tier permissions. ``` @@ -178,7 +178,7 @@ Follow this link to add your bot to your server. ###### Bot -Head to the `Bot` section of the Discord application and copy your bot token. +Head to the `Bot` section of the Discord application and copy your bot token. Paste it into `config.discord.token` Ensure you enable the `Server Members` and `Message Content` intents under the **Privileged Gateway Intents** subsection before usage, the bot will not start otherwise, and you will be provided a `[DISALLOWED INTENTS]` error. @@ -214,13 +214,13 @@ The database will listen on `127.0.0.1:3306`, with `corsace` being the database ##### Manual MariaDB Setup -If you do not want to use Docker, you will need to install [MariaDB](https://mariadb.org/) and create an empty database, named whatever you like. +If you do not want to use Docker, you will need to install [MariaDB](https://mariadb.org/) and create an empty database, named whatever you like. It can be as simple as running: ```bash mysql -u root -p -MySQL> create database ; +MySQL> create database ; ``` Make sure to update `config.database` to reflect your choice of database name and credentials. @@ -239,7 +239,7 @@ We use three buckets: - `team-avatars` is a public bucket that stores team avatars, can be served by a CDN without authentication - `mappacks` is a public bucket that stores public mappacks, can be served by a CDN without authentication -- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access +- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access Generated mappacks are first uploaded to this bucket, users are given access through pre-signed URLs. @@ -267,7 +267,7 @@ On Unix: Run `npm run centrifugo` to start the centrifugo server. It will be available at `http://localhost:8001` by default, unless you change the port in the config files. On WSL/Windows OR if the above doesn't work: -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. Afterwards, run `npm run centrifugo:local` to start the centrifugo server. If you want to change the port, change the `-p` flag in the respective script in `package.json`, and your config file's api URL. :::note diff --git a/Docs/src/content/docs/nl/development/Client/Guide/docs-write-edit-documents.mdx b/Docs/src/content/docs/nl/development/Client/Guide/docs-write-edit-documents.mdx index fa478ba8ce..7451b28a80 100644 --- a/Docs/src/content/docs/nl/development/Client/Guide/docs-write-edit-documents.mdx +++ b/Docs/src/content/docs/nl/development/Client/Guide/docs-write-edit-documents.mdx @@ -26,7 +26,6 @@ For any document you wish to create, it must reside somewhere within `Docs/src/c The folder structure within this is similar to the sidebar's hierarchy on the website.\ Primarily, there are 3 main sections: -* [Design Documentation](../../../../design) * [Development Documentation](../../../../development) * [Documentation on how to run tournaments via Corsace](../../../../tournament_org) * [Documentation on playing in tournaments run via Corsace](../../../../tournament_play) diff --git a/Docs/src/content/docs/nl/development/Server/Guide/centrifugo-running-environment.mdx b/Docs/src/content/docs/nl/development/Server/Guide/centrifugo-running-environment.mdx index e399c142ee..6a4edaea36 100644 --- a/Docs/src/content/docs/nl/development/Server/Guide/centrifugo-running-environment.mdx +++ b/Docs/src/content/docs/nl/development/Server/Guide/centrifugo-running-environment.mdx @@ -21,22 +21,42 @@ The majority of the setup should already be done based on the parent Getting Sta In the main directory, there is a `centrifugo-config.json`. -Ensure that in `allowed_origins` that the value in `config.open.publicUrl` is the array value.\ -Ensure that in `proxy_connect_endpoint` and `proxy_subscribe_endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ -The value for `proxy_subscribe` should also be `true`. +Ensure that in `client.allowed_origins` that the value in `config.open.publicUrl` is the array value.\ +Ensure that in `client.proxy.connect.endpoint` and `channel.proxy.subscribe.endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ +The value for `channel.namespaces[...].subscribe_proxy_enabled` should also be `true`. For example, if my `config.open.publicUrl` was `http://localhost:7000`, and my `config.api.publicUrl` was `http://localhost:8080`, then my `centrifugo-config.json` would look like this: ```json { ..., - "allowed_origins": [..., "http://localhost:7000", ...], + "client": { + ..., + "allowed_origins": [..., "http://localhost:7000", ...], + "proxy": { + "connect": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", + ... + } + } + }, ..., - "proxy_connect_endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", - ..., - "proxy_subscribe_endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", - ..., - "proxy_subscribe": true + "channel": { + "proxy": { + "subscribe": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", + ... + } + }, + "namespaces": [ + { + "name": "matchup", + "subscribe_proxy_enabled": true, + ... + }, + ... + ], + ... } ``` @@ -54,7 +74,7 @@ In the console, there should be no errors when running. This is only for if the above doesn't work, which can happen in Windows/WSL. -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ Afterwards, go to `scripts.centrifugo:local` in `package.json` located in the parent directory, and ensure it has the same port listed in `config.centrifugo.publicUrl` and `config.centrifugo.apiUrl`. Once done, it should run using the following command diff --git a/Docs/src/content/docs/nl/development/index.mdx b/Docs/src/content/docs/nl/development/index.mdx index e0dad99ecf..5fbc4d47c2 100644 --- a/Docs/src/content/docs/nl/development/index.mdx +++ b/Docs/src/content/docs/nl/development/index.mdx @@ -70,7 +70,7 @@ The values in your personal `config/user/$USER.json` config file will be referre :::note - Appearance > Advanced > Developer Mode @@ -130,7 +130,7 @@ Create a "staff" role and give it to yourself. Right-click your server name and "Copy ID". Paste this into `config.discord.guild`. -Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR +Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR paste that role ID into the following config values to give yourself god-tier permissions. ``` @@ -178,7 +178,7 @@ Follow this link to add your bot to your server. ###### Bot -Head to the `Bot` section of the Discord application and copy your bot token. +Head to the `Bot` section of the Discord application and copy your bot token. Paste it into `config.discord.token` Ensure you enable the `Server Members` and `Message Content` intents under the **Privileged Gateway Intents** subsection before usage, the bot will not start otherwise, and you will be provided a `[DISALLOWED INTENTS]` error. @@ -214,13 +214,13 @@ The database will listen on `127.0.0.1:3306`, with `corsace` being the database ##### Manual MariaDB Setup -If you do not want to use Docker, you will need to install [MariaDB](https://mariadb.org/) and create an empty database, named whatever you like. +If you do not want to use Docker, you will need to install [MariaDB](https://mariadb.org/) and create an empty database, named whatever you like. It can be as simple as running: ```bash mysql -u root -p -MySQL> create database ; +MySQL> create database ; ``` Make sure to update `config.database` to reflect your choice of database name and credentials. @@ -239,7 +239,7 @@ We use three buckets: - `team-avatars` is a public bucket that stores team avatars, can be served by a CDN without authentication - `mappacks` is a public bucket that stores public mappacks, can be served by a CDN without authentication -- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access +- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access Generated mappacks are first uploaded to this bucket, users are given access through pre-signed URLs. @@ -267,7 +267,7 @@ On Unix: Run `npm run centrifugo` to start the centrifugo server. It will be available at `http://localhost:8001` by default, unless you change the port in the config files. On WSL/Windows OR if the above doesn't work: -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. Afterwards, run `npm run centrifugo:local` to start the centrifugo server. If you want to change the port, change the `-p` flag in the respective script in `package.json`, and your config file's api URL. :::note diff --git a/Docs/src/content/docs/pl/development/Client/Guide/docs-write-edit-documents.mdx b/Docs/src/content/docs/pl/development/Client/Guide/docs-write-edit-documents.mdx index a401ed2173..469ba42cc2 100644 --- a/Docs/src/content/docs/pl/development/Client/Guide/docs-write-edit-documents.mdx +++ b/Docs/src/content/docs/pl/development/Client/Guide/docs-write-edit-documents.mdx @@ -26,7 +26,6 @@ For any document you wish to create, it must reside somewhere within `Docs/src/c The folder structure within this is similar to the sidebar's hierarchy on the website.\ Primarily, there are 3 main sections: -* [Design Documentation](../../../../design) * [Development Documentation](../../../../development) * [Documentation on how to run tournaments via Corsace](../../../../tournament_org) * [Documentation on playing in tournaments run via Corsace](../../../../tournament_play) diff --git a/Docs/src/content/docs/pl/development/Server/Guide/centrifugo-running-environment.mdx b/Docs/src/content/docs/pl/development/Server/Guide/centrifugo-running-environment.mdx index e399c142ee..6a4edaea36 100644 --- a/Docs/src/content/docs/pl/development/Server/Guide/centrifugo-running-environment.mdx +++ b/Docs/src/content/docs/pl/development/Server/Guide/centrifugo-running-environment.mdx @@ -21,22 +21,42 @@ The majority of the setup should already be done based on the parent Getting Sta In the main directory, there is a `centrifugo-config.json`. -Ensure that in `allowed_origins` that the value in `config.open.publicUrl` is the array value.\ -Ensure that in `proxy_connect_endpoint` and `proxy_subscribe_endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ -The value for `proxy_subscribe` should also be `true`. +Ensure that in `client.allowed_origins` that the value in `config.open.publicUrl` is the array value.\ +Ensure that in `client.proxy.connect.endpoint` and `channel.proxy.subscribe.endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ +The value for `channel.namespaces[...].subscribe_proxy_enabled` should also be `true`. For example, if my `config.open.publicUrl` was `http://localhost:7000`, and my `config.api.publicUrl` was `http://localhost:8080`, then my `centrifugo-config.json` would look like this: ```json { ..., - "allowed_origins": [..., "http://localhost:7000", ...], + "client": { + ..., + "allowed_origins": [..., "http://localhost:7000", ...], + "proxy": { + "connect": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", + ... + } + } + }, ..., - "proxy_connect_endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", - ..., - "proxy_subscribe_endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", - ..., - "proxy_subscribe": true + "channel": { + "proxy": { + "subscribe": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", + ... + } + }, + "namespaces": [ + { + "name": "matchup", + "subscribe_proxy_enabled": true, + ... + }, + ... + ], + ... } ``` @@ -54,7 +74,7 @@ In the console, there should be no errors when running. This is only for if the above doesn't work, which can happen in Windows/WSL. -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ Afterwards, go to `scripts.centrifugo:local` in `package.json` located in the parent directory, and ensure it has the same port listed in `config.centrifugo.publicUrl` and `config.centrifugo.apiUrl`. Once done, it should run using the following command diff --git a/Docs/src/content/docs/pl/development/index.mdx b/Docs/src/content/docs/pl/development/index.mdx index e0dad99ecf..5fbc4d47c2 100644 --- a/Docs/src/content/docs/pl/development/index.mdx +++ b/Docs/src/content/docs/pl/development/index.mdx @@ -70,7 +70,7 @@ The values in your personal `config/user/$USER.json` config file will be referre :::note - Appearance > Advanced > Developer Mode @@ -130,7 +130,7 @@ Create a "staff" role and give it to yourself. Right-click your server name and "Copy ID". Paste this into `config.discord.guild`. -Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR +Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR paste that role ID into the following config values to give yourself god-tier permissions. ``` @@ -178,7 +178,7 @@ Follow this link to add your bot to your server. ###### Bot -Head to the `Bot` section of the Discord application and copy your bot token. +Head to the `Bot` section of the Discord application and copy your bot token. Paste it into `config.discord.token` Ensure you enable the `Server Members` and `Message Content` intents under the **Privileged Gateway Intents** subsection before usage, the bot will not start otherwise, and you will be provided a `[DISALLOWED INTENTS]` error. @@ -214,13 +214,13 @@ The database will listen on `127.0.0.1:3306`, with `corsace` being the database ##### Manual MariaDB Setup -If you do not want to use Docker, you will need to install [MariaDB](https://mariadb.org/) and create an empty database, named whatever you like. +If you do not want to use Docker, you will need to install [MariaDB](https://mariadb.org/) and create an empty database, named whatever you like. It can be as simple as running: ```bash mysql -u root -p -MySQL> create database ; +MySQL> create database ; ``` Make sure to update `config.database` to reflect your choice of database name and credentials. @@ -239,7 +239,7 @@ We use three buckets: - `team-avatars` is a public bucket that stores team avatars, can be served by a CDN without authentication - `mappacks` is a public bucket that stores public mappacks, can be served by a CDN without authentication -- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access +- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access Generated mappacks are first uploaded to this bucket, users are given access through pre-signed URLs. @@ -267,7 +267,7 @@ On Unix: Run `npm run centrifugo` to start the centrifugo server. It will be available at `http://localhost:8001` by default, unless you change the port in the config files. On WSL/Windows OR if the above doesn't work: -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. Afterwards, run `npm run centrifugo:local` to start the centrifugo server. If you want to change the port, change the `-p` flag in the respective script in `package.json`, and your config file's api URL. :::note diff --git a/Docs/src/content/docs/ru/development/Client/Guide/docs-write-edit-documents.mdx b/Docs/src/content/docs/ru/development/Client/Guide/docs-write-edit-documents.mdx index fa478ba8ce..7451b28a80 100644 --- a/Docs/src/content/docs/ru/development/Client/Guide/docs-write-edit-documents.mdx +++ b/Docs/src/content/docs/ru/development/Client/Guide/docs-write-edit-documents.mdx @@ -26,7 +26,6 @@ For any document you wish to create, it must reside somewhere within `Docs/src/c The folder structure within this is similar to the sidebar's hierarchy on the website.\ Primarily, there are 3 main sections: -* [Design Documentation](../../../../design) * [Development Documentation](../../../../development) * [Documentation on how to run tournaments via Corsace](../../../../tournament_org) * [Documentation on playing in tournaments run via Corsace](../../../../tournament_play) diff --git a/Docs/src/content/docs/ru/development/Server/Guide/centrifugo-running-environment.mdx b/Docs/src/content/docs/ru/development/Server/Guide/centrifugo-running-environment.mdx index e399c142ee..6a4edaea36 100644 --- a/Docs/src/content/docs/ru/development/Server/Guide/centrifugo-running-environment.mdx +++ b/Docs/src/content/docs/ru/development/Server/Guide/centrifugo-running-environment.mdx @@ -21,22 +21,42 @@ The majority of the setup should already be done based on the parent Getting Sta In the main directory, there is a `centrifugo-config.json`. -Ensure that in `allowed_origins` that the value in `config.open.publicUrl` is the array value.\ -Ensure that in `proxy_connect_endpoint` and `proxy_subscribe_endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ -The value for `proxy_subscribe` should also be `true`. +Ensure that in `client.allowed_origins` that the value in `config.open.publicUrl` is the array value.\ +Ensure that in `client.proxy.connect.endpoint` and `channel.proxy.subscribe.endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ +The value for `channel.namespaces[...].subscribe_proxy_enabled` should also be `true`. For example, if my `config.open.publicUrl` was `http://localhost:7000`, and my `config.api.publicUrl` was `http://localhost:8080`, then my `centrifugo-config.json` would look like this: ```json { ..., - "allowed_origins": [..., "http://localhost:7000", ...], + "client": { + ..., + "allowed_origins": [..., "http://localhost:7000", ...], + "proxy": { + "connect": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", + ... + } + } + }, ..., - "proxy_connect_endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", - ..., - "proxy_subscribe_endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", - ..., - "proxy_subscribe": true + "channel": { + "proxy": { + "subscribe": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", + ... + } + }, + "namespaces": [ + { + "name": "matchup", + "subscribe_proxy_enabled": true, + ... + }, + ... + ], + ... } ``` @@ -54,7 +74,7 @@ In the console, there should be no errors when running. This is only for if the above doesn't work, which can happen in Windows/WSL. -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ Afterwards, go to `scripts.centrifugo:local` in `package.json` located in the parent directory, and ensure it has the same port listed in `config.centrifugo.publicUrl` and `config.centrifugo.apiUrl`. Once done, it should run using the following command diff --git a/Docs/src/content/docs/ru/development/index.mdx b/Docs/src/content/docs/ru/development/index.mdx index e0dad99ecf..5fbc4d47c2 100644 --- a/Docs/src/content/docs/ru/development/index.mdx +++ b/Docs/src/content/docs/ru/development/index.mdx @@ -70,7 +70,7 @@ The values in your personal `config/user/$USER.json` config file will be referre :::note - Appearance > Advanced > Developer Mode @@ -130,7 +130,7 @@ Create a "staff" role and give it to yourself. Right-click your server name and "Copy ID". Paste this into `config.discord.guild`. -Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR +Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR paste that role ID into the following config values to give yourself god-tier permissions. ``` @@ -178,7 +178,7 @@ Follow this link to add your bot to your server. ###### Bot -Head to the `Bot` section of the Discord application and copy your bot token. +Head to the `Bot` section of the Discord application and copy your bot token. Paste it into `config.discord.token` Ensure you enable the `Server Members` and `Message Content` intents under the **Privileged Gateway Intents** subsection before usage, the bot will not start otherwise, and you will be provided a `[DISALLOWED INTENTS]` error. @@ -214,13 +214,13 @@ The database will listen on `127.0.0.1:3306`, with `corsace` being the database ##### Manual MariaDB Setup -If you do not want to use Docker, you will need to install [MariaDB](https://mariadb.org/) and create an empty database, named whatever you like. +If you do not want to use Docker, you will need to install [MariaDB](https://mariadb.org/) and create an empty database, named whatever you like. It can be as simple as running: ```bash mysql -u root -p -MySQL> create database ; +MySQL> create database ; ``` Make sure to update `config.database` to reflect your choice of database name and credentials. @@ -239,7 +239,7 @@ We use three buckets: - `team-avatars` is a public bucket that stores team avatars, can be served by a CDN without authentication - `mappacks` is a public bucket that stores public mappacks, can be served by a CDN without authentication -- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access +- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access Generated mappacks are first uploaded to this bucket, users are given access through pre-signed URLs. @@ -267,7 +267,7 @@ On Unix: Run `npm run centrifugo` to start the centrifugo server. It will be available at `http://localhost:8001` by default, unless you change the port in the config files. On WSL/Windows OR if the above doesn't work: -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. Afterwards, run `npm run centrifugo:local` to start the centrifugo server. If you want to change the port, change the `-p` flag in the respective script in `package.json`, and your config file's api URL. :::note diff --git a/Docs/src/content/docs/vn/development/Client/Guide/docs-write-edit-documents.mdx b/Docs/src/content/docs/vn/development/Client/Guide/docs-write-edit-documents.mdx index 59ff7529d2..e8541b1d1b 100644 --- a/Docs/src/content/docs/vn/development/Client/Guide/docs-write-edit-documents.mdx +++ b/Docs/src/content/docs/vn/development/Client/Guide/docs-write-edit-documents.mdx @@ -26,7 +26,6 @@ For any document you wish to create, it must reside somewhere within `Docs/src/c The folder structure within this is similar to the sidebar's hierarchy on the website.\ Primarily, there are 3 main sections: -* [Design Documentation](design) * [Development Documentation](development) * [Documentation on how to run tournaments via Corsace](tournaments) * [Documentation on playing in tournaments run via Corsace](../../../../tournament_play) diff --git a/Docs/src/content/docs/vn/development/Server/Guide/centrifugo-running-environment.mdx b/Docs/src/content/docs/vn/development/Server/Guide/centrifugo-running-environment.mdx index e399c142ee..6a4edaea36 100644 --- a/Docs/src/content/docs/vn/development/Server/Guide/centrifugo-running-environment.mdx +++ b/Docs/src/content/docs/vn/development/Server/Guide/centrifugo-running-environment.mdx @@ -21,22 +21,42 @@ The majority of the setup should already be done based on the parent Getting Sta In the main directory, there is a `centrifugo-config.json`. -Ensure that in `allowed_origins` that the value in `config.open.publicUrl` is the array value.\ -Ensure that in `proxy_connect_endpoint` and `proxy_subscribe_endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ -The value for `proxy_subscribe` should also be `true`. +Ensure that in `client.allowed_origins` that the value in `config.open.publicUrl` is the array value.\ +Ensure that in `client.proxy.connect.endpoint` and `channel.proxy.subscribe.endpoint` that the value in `config.api.publicUrl` is there. It should consist of api endpoints `/api/centrifugo/connect` and `/api/centrifugo/subscribe` in there respectively.\ +The value for `channel.namespaces[...].subscribe_proxy_enabled` should also be `true`. For example, if my `config.open.publicUrl` was `http://localhost:7000`, and my `config.api.publicUrl` was `http://localhost:8080`, then my `centrifugo-config.json` would look like this: ```json { ..., - "allowed_origins": [..., "http://localhost:7000", ...], + "client": { + ..., + "allowed_origins": [..., "http://localhost:7000", ...], + "proxy": { + "connect": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", + ... + } + } + }, ..., - "proxy_connect_endpoint": "http://127.0.0.1:8080/api/centrifugo/connect", - ..., - "proxy_subscribe_endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", - ..., - "proxy_subscribe": true + "channel": { + "proxy": { + "subscribe": { + "endpoint": "http://127.0.0.1:8080/api/centrifugo/subscribe", + ... + } + }, + "namespaces": [ + { + "name": "matchup", + "subscribe_proxy_enabled": true, + ... + }, + ... + ], + ... } ``` @@ -54,7 +74,7 @@ In the console, there should be no errors when running. This is only for if the above doesn't work, which can happen in Windows/WSL. -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and place it in the parent directory.\ Afterwards, go to `scripts.centrifugo:local` in `package.json` located in the parent directory, and ensure it has the same port listed in `config.centrifugo.publicUrl` and `config.centrifugo.apiUrl`. Once done, it should run using the following command diff --git a/Docs/src/content/docs/vn/development/index.mdx b/Docs/src/content/docs/vn/development/index.mdx index e0dad99ecf..5fbc4d47c2 100644 --- a/Docs/src/content/docs/vn/development/index.mdx +++ b/Docs/src/content/docs/vn/development/index.mdx @@ -70,7 +70,7 @@ The values in your personal `config/user/$USER.json` config file will be referre :::note - Appearance > Advanced > Developer Mode @@ -130,7 +130,7 @@ Create a "staff" role and give it to yourself. Right-click your server name and "Copy ID". Paste this into `config.discord.guild`. -Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR +Right-click your staff role and "Copy ID". You can either create a role for each corresponding role in the config, OR paste that role ID into the following config values to give yourself god-tier permissions. ``` @@ -178,7 +178,7 @@ Follow this link to add your bot to your server. ###### Bot -Head to the `Bot` section of the Discord application and copy your bot token. +Head to the `Bot` section of the Discord application and copy your bot token. Paste it into `config.discord.token` Ensure you enable the `Server Members` and `Message Content` intents under the **Privileged Gateway Intents** subsection before usage, the bot will not start otherwise, and you will be provided a `[DISALLOWED INTENTS]` error. @@ -214,13 +214,13 @@ The database will listen on `127.0.0.1:3306`, with `corsace` being the database ##### Manual MariaDB Setup -If you do not want to use Docker, you will need to install [MariaDB](https://mariadb.org/) and create an empty database, named whatever you like. +If you do not want to use Docker, you will need to install [MariaDB](https://mariadb.org/) and create an empty database, named whatever you like. It can be as simple as running: ```bash mysql -u root -p -MySQL> create database ; +MySQL> create database ; ``` Make sure to update `config.database` to reflect your choice of database name and credentials. @@ -239,7 +239,7 @@ We use three buckets: - `team-avatars` is a public bucket that stores team avatars, can be served by a CDN without authentication - `mappacks` is a public bucket that stores public mappacks, can be served by a CDN without authentication -- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access +- `mappacks-temp` is a private bucket that stores private mappacks that should not have public access Generated mappacks are first uploaded to this bucket, users are given access through pre-signed URLs. @@ -267,7 +267,7 @@ On Unix: Run `npm run centrifugo` to start the centrifugo server. It will be available at `http://localhost:8001` by default, unless you change the port in the config files. On WSL/Windows OR if the above doesn't work: -Download the binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. +Download a v6.x.x binary from [latest releases](https://github.com/centrifugal/centrifugo/releases), and add it to the root folder of this project. Afterwards, run `npm run centrifugo:local` to start the centrifugo server. If you want to change the port, change the `-p` flag in the respective script in `package.json`, and your config file's api URL. :::note