Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
67603bc
New translations docs-write-edit-documents.mdx (Chinese Simplified)
VINXIS Sep 4, 2024
d06316e
New translations docs-write-edit-documents.mdx (French)
VINXIS Sep 4, 2024
eeb73b6
New translations docs-write-edit-documents.mdx (Spanish)
VINXIS Sep 4, 2024
b384973
New translations docs-write-edit-documents.mdx (German)
VINXIS Sep 4, 2024
caec2a5
New translations docs-write-edit-documents.mdx (Greek)
VINXIS Sep 4, 2024
76da388
New translations docs-write-edit-documents.mdx (Italian)
VINXIS Sep 4, 2024
0ebefc5
New translations docs-write-edit-documents.mdx (Japanese)
VINXIS Sep 4, 2024
e5ad31f
New translations docs-write-edit-documents.mdx (Korean)
VINXIS Sep 4, 2024
910034f
New translations docs-write-edit-documents.mdx (Dutch)
VINXIS Sep 4, 2024
650dd62
New translations docs-write-edit-documents.mdx (Polish)
VINXIS Sep 4, 2024
55a7c16
New translations docs-write-edit-documents.mdx (Russian)
VINXIS Sep 4, 2024
22bb7db
New translations docs-write-edit-documents.mdx (Vietnamese)
VINXIS Sep 4, 2024
c9d4bd8
New translations docs-write-edit-documents.mdx (Portuguese, Brazilian)
VINXIS Sep 4, 2024
5e78ed7
New translations docs-write-edit-documents.mdx (Indonesian)
VINXIS Sep 4, 2024
3a693e8
New translations index.mdx (French)
VINXIS Feb 28, 2025
cdc2ffd
New translations centrifugo-running-environment.mdx (French)
VINXIS Feb 28, 2025
926ae16
New translations index.mdx (Spanish)
VINXIS Feb 28, 2025
49570b8
New translations centrifugo-running-environment.mdx (Spanish)
VINXIS Feb 28, 2025
0f330da
New translations index.mdx (German)
VINXIS Feb 28, 2025
21478d4
New translations centrifugo-running-environment.mdx (German)
VINXIS Feb 28, 2025
a1591ef
New translations index.mdx (Greek)
VINXIS Feb 28, 2025
2542769
New translations centrifugo-running-environment.mdx (Greek)
VINXIS Feb 28, 2025
0afb009
New translations index.mdx (Italian)
VINXIS Feb 28, 2025
486dad1
New translations centrifugo-running-environment.mdx (Italian)
VINXIS Feb 28, 2025
b45342b
New translations index.mdx (Japanese)
VINXIS Feb 28, 2025
188e489
New translations centrifugo-running-environment.mdx (Japanese)
VINXIS Feb 28, 2025
73ad850
New translations index.mdx (Korean)
VINXIS Feb 28, 2025
e659695
New translations centrifugo-running-environment.mdx (Korean)
VINXIS Feb 28, 2025
3c428b6
New translations index.mdx (Dutch)
VINXIS Feb 28, 2025
564203f
New translations centrifugo-running-environment.mdx (Dutch)
VINXIS Feb 28, 2025
4cb186d
New translations index.mdx (Polish)
VINXIS Feb 28, 2025
a3860f7
New translations centrifugo-running-environment.mdx (Polish)
VINXIS Feb 28, 2025
20bda70
New translations index.mdx (Russian)
VINXIS Feb 28, 2025
3467f46
New translations centrifugo-running-environment.mdx (Russian)
VINXIS Feb 28, 2025
b813496
New translations index.mdx (Chinese Simplified)
VINXIS Feb 28, 2025
db69dab
New translations centrifugo-running-environment.mdx (Chinese Simplified)
VINXIS Feb 28, 2025
3c6217e
New translations index.mdx (Vietnamese)
VINXIS Feb 28, 2025
079bbc2
New translations centrifugo-running-environment.mdx (Vietnamese)
VINXIS Feb 28, 2025
6b7d2dc
New translations index.mdx (Portuguese, Brazilian)
VINXIS Feb 28, 2025
d5cb3e2
New translations centrifugo-running-environment.mdx (Portuguese, Braz…
VINXIS Feb 28, 2025
2428275
New translations index.mdx (Indonesian)
VINXIS Feb 28, 2025
0efaa14
New translations centrifugo-running-environment.mdx (Indonesian)
VINXIS Feb 28, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,
...
},
...
],
...
}
```

Expand All @@ -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

Expand Down
20 changes: 11 additions & 9 deletions Docs/src/content/docs/br/development/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Os valores no seu arquivo de configuração pessoal `config/user/$USER.json` ser

:::note

<LinkCard
<LinkCard
title="STOP HERE FOR DOCS SETUP"
description="If you wish to work on documentation, you may stop here and continue at the client guides section."
href="client/guide/docs-running-environment"
Expand Down Expand Up @@ -110,12 +110,12 @@ Se sua conta for uma conta de bot, certifique-se de ter `botAccount` definido co

#### Setup

This is the most time-consuming part of the setup.
This is the most time-consuming part of the setup.
You will need the following:

##### Enable Developer Mode

Check the option at
Check the option at

```
User Settings > Appearance > Advanced > Developer Mode
Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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 <new_db_name>;
MySQL> create database <new_db_name>;
```

Certifique-se de atualizar `config.database` para refletir sua escolha de nome e credenciais do banco de dados.
Expand All @@ -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.

Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ import WorkInProgress from '../../../../../../components/WorkInProgress.astro';
其中的文件夹结构类似于网站上侧边栏的层次结构。\
总的来看,有三个主要部分:

* [设计文档](design)
* [开发文档](development)
* [如何在 Corsace 运行比赛的文档](tournaments)
* [Documentation on playing in tournaments run via Corsace](../../../../tournament_play)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,
...
},
...
],
...
}
```

Expand All @@ -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

Expand Down
18 changes: 9 additions & 9 deletions Docs/src/content/docs/cn/development/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ The values in your personal `config/user/$USER.json` config file will be referre

:::note

<LinkCard
<LinkCard
title="STOP HERE FOR DOCS SETUP"
description="If you wish to work on documentation, you may stop here and continue at the client guides section."
href="client/guide/docs-running-environment"
Expand Down Expand Up @@ -110,12 +110,12 @@ If your account is a bot account, then make sure to have `botAccount` set to tru

#### Setup

This is the most time-consuming part of the setup.
This is the most time-consuming part of the setup.
You will need the following:

##### Enable Developer Mode

Check the option at
Check the option at

```
User Settings > Appearance > Advanced > Developer Mode
Expand All @@ -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.

```
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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 <new_db_name>;
MySQL> create database <new_db_name>;
```

Make sure to update `config.database` to reflect your choice of database name and credentials.
Expand All @@ -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.

Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,
...
},
...
],
...
}
```

Expand All @@ -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

Expand Down
Loading
Loading