Skip to content
This repository was archived by the owner on Aug 7, 2025. It is now read-only.

Commit f5ea49f

Browse files
committed
.
1 parent bb39d3b commit f5ea49f

File tree

10 files changed

+40
-40
lines changed

10 files changed

+40
-40
lines changed

docs/exhaustive-documentation/environment-variables.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ console.log(`Hello ${process.env.VAR_NAME}`)
4141

4242
## Using Environment Variables When Building Images
4343

44-
When building Docker images, we need to be careful to avoid including the variables in the images. Disco uses the recommended way to expose environment variables without baking them into the images.
44+
When building Docker images, we need to be careful to avoid including the variables in the images. disco uses the recommended way to expose environment variables without baking them into the images.
4545

4646
See Docker documentation about [Build Secrets](https://docs.docker.com/build/building/secrets/) for more info.
4747

@@ -86,7 +86,7 @@ The [Docker documentation](https://docs.docker.com/build/building/secrets/#targe
8686
RUN --mount=type=secret,id=aws,target=/root/.aws/credentials \
8787
aws s3 cp ...
8888
```
89-
We can adapt it to Disco's environment variables like
89+
We can adapt it to disco's environment variables like
9090
```bash
9191
disco env:set --projecct my-project AWS_CREDENTIALS='...'
9292
```

docs/exhaustive-documentation/images.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ You can avoid talking about images in your `disco.json` file by relying on the d
4343

4444
This `disco.json` above uses the defaults. More on this below.
4545

46-
When you don't specify the image to use for a service, Disco will default to the image named `default`.
46+
When you don't specify the image to use for a service, disco will default to the image named `default`.
4747

4848
Those two `disco.json` are equivalent, defining `"image"` or not in the definition of `"web"`:
4949

@@ -84,7 +84,7 @@ and
8484
}
8585
```
8686

87-
Also, when not defining the `default` image, Disco will assume the default value shown above. That is, the `Dockerfile` at the root of the repository, the build context as well. Meaning that this third `disco.json` is also equivalent:
87+
Also, when not defining the `default` image, disco will assume the default value shown above. That is, the `Dockerfile` at the root of the repository, the build context as well. Meaning that this third `disco.json` is also equivalent:
8888
```json
8989
{
9090
"version": "1.0",
@@ -175,7 +175,7 @@ or another exmaple, if the Dockerfile is in a sub-directory, but should be built
175175

176176
## Using Publicly Downloadable Images
177177

178-
If the name of the image to use is not defined in `images`, Disco will see if it can download it.
178+
If the name of the image to use is not defined in `images`, disco will see if it can download it.
179179

180180
```json
181181
{

docs/exhaustive-documentation/ports.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Web
44

5-
When deploying a web application, the way to have the web traffic served through Disco's reverse proxy is to specify the port in your `disco.json`.
5+
When deploying a web application, the way to have the web traffic served through disco's reverse proxy is to specify the port in your `disco.json`.
66

77
```json
88
{
@@ -16,9 +16,9 @@ When deploying a web application, the way to have the web traffic served through
1616
}
1717
```
1818

19-
That way, requests come in to your server on port 443 (for https) and Disco's reverse proxy will forward the request to your app on port 8080.
19+
That way, requests come in to your server on port 443 (for https) and disco's reverse proxy will forward the request to your app on port 8080.
2020

21-
Also, note that the name `web` for the service is important. Disco will use that service to expose to the internet. You can't specify `port` on a service not named `web`.
21+
Also, note that the name `web` for the service is important. disco will use that service to expose to the internet. You can't specify `port` on a service not named `web`.
2222

2323
## Internal Communication Between Services
2424

@@ -94,4 +94,4 @@ In the case where you would like to expose a port externally, bypassing the reve
9494

9595
In this case, the container's port `11000` will be exposed on the server directly as port `12000`. Also, the protocol defined is `udp`, or `tcp`.
9696

97-
Since it does not go through the reverse proxy, Disco will not provide a TLS certificate for HTTPS.
97+
Since it does not go through the reverse proxy, disco will not provide a TLS certificate for HTTPS.

docs/exhaustive-documentation/postgresql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ You can attach many databases to a single project. And you can attach the same d
111111

112112
### Remote Access
113113

114-
As you saw in the `DATABASE_URL` value, the hostname was `postgres-instance-nuclear-rabbit-postgres`. It's not exposed to the internet. It's only accessible to the projects running on your Disco installation.
114+
As you saw in the `DATABASE_URL` value, the hostname was `postgres-instance-nuclear-rabbit-postgres`. It's not exposed to the internet. It's only accessible to the projects running on your disco installation.
115115

116116
If you want to access it remotely, from your laptop for example, you can create a temporary tunnel.
117117

docs/exhaustive-documentation/volumes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,4 +54,4 @@ Volumes are scoped per project. If you use the same volume name for 2 different
5454

5555
## Scaling Considerations
5656

57-
When running Disco with multiple servers (nodes in a swarm), usually, services will be spread on all servers automatically to spread the load. However, when using volumes, Disco will force the services to run on the main node and the volumes will be created on the hard drive of the main node. In other words, services that use volumes will not scale horiztonally.
57+
When running disco with multiple servers (nodes in a swarm), usually, services will be spread on all servers automatically to spread the load. However, when using volumes, disco will force the services to run on the main node and the volumes will be created on the hard drive of the main node. In other words, services that use volumes will not scale horiztonally.

docs/exhaustive-documentation/worker-processes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Worker Processes
22

3-
In your `disco.json` file, you can define many services. The one that has the name `web` will be exposed to the internet by Disco. The other ones will just run.
3+
In your `disco.json` file, you can define many services. The one that has the name `web` will be exposed to the internet by disco. The other ones will just run.
44

55
```json
66
{

docs/get-started/set-up-your-app.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ sidebar_position: 4
44

55
# Set up your App
66

7-
In this docs you will learn the basics to get your existing app running on Disco. If you have a static site or a static site generator, refer to these sections instead.
7+
In this docs you will learn the basics to get your existing app running on disco. If you have a static site or a static site generator, refer to these sections instead.
88

99
## Overview
1010

11-
At this point, you already have installed the CLI on your computer, installed Disco on your server, and you have added your Disco Github app with the permissions to your repository on Github.
11+
At this point, you already have installed the CLI on your computer, installed disco on your server, and you have added your disco Github app with the permissions to your repository on Github.
1212

13-
After this guide, you will have a `Dockerfile` to build the image of your app, and you'll have a `disco.json` file describing how the app should run on Disco.
13+
After this guide, you will have a `Dockerfile` to build the image of your app, and you'll have a `disco.json` file describing how the app should run on disco.
1414

15-
### The app before Disco
15+
### The app before disco
1616

1717
Let's use a very basic Flask app so that we have something to work with.
1818

@@ -60,7 +60,7 @@ $ flask --app hello run
6060

6161
### Create your Dockerfile
6262

63-
Apps on Disco run inside Docker containers. We need a Dockerfile to build the image that will be used by those containers. If you've never worked with Docker or `Dockerfile`, the general idea is that the `Dockerfile` will build everything needed to run the app, so that we can use it later to execute the app. You can see it as a `makefile` to build binaries that you'll later use when you want to run the app.
63+
Apps on disco run inside Docker containers. We need a Dockerfile to build the image that will be used by those containers. If you've never worked with Docker or `Dockerfile`, the general idea is that the `Dockerfile` will build everything needed to run the app, so that we can use it later to execute the app. You can see it as a `makefile` to build binaries that you'll later use when you want to run the app.
6464

6565
For this example, in Python, we'll use the official Python image from Docker Hub. Just create a file named `Dockerfile` at the root of your repository.
6666

@@ -75,7 +75,7 @@ See [notes below](#optimizing-the-dockerfile) for some optimizations we can make
7575

7676
### Create your disco.json
7777

78-
Create a file named `disco.json` at the root of your repository. The `disco.json` file tells Disco how to run your app.
78+
Create a file named `disco.json` at the root of your repository. The `disco.json` file tells disco how to run your app.
7979

8080
One note is that services have to be accessible from the outside. See [Externally Visible Server](https://flask.palletsprojects.com/en/3.0.x/quickstart/#public-server) in Flask's docs. While the flag `--host=0.0.0.0` is Flask specific, the concept applies to most apps: it may bind to `127.0.0.1` (`localhost`) by default, meaning only requests coming from "inside" would be able to reach the app. This is a great default for developping on your computer, but to deploy your application, it needs to be accessible from the outside, so that the reverse proxy in front of your app can talk to it.
8181

@@ -91,11 +91,11 @@ One note is that services have to be accessible from the outside. See [Externall
9191
}
9292
```
9393

94-
The name `web` is a magic name. When Disco sees it, it knows that it's the one to use to expose to the internet, create a TLS certificate for HTTPS, etc.
94+
The name `web` is a magic name. When disco sees it, it knows that it's the one to use to expose to the internet, create a TLS certificate for HTTPS, etc.
9595

9696
### That's it!
9797

98-
Your app is now ready to be deployed on Disco. You can use the CLI to add the project.
98+
Your app is now ready to be deployed on disco. You can use the CLI to add the project.
9999

100100
```bash
101101
disco projects:add \
@@ -104,7 +104,7 @@ disco projects:add \
104104
--domain first-app.example.com
105105
```
106106

107-
And now, every time you `git push` new commits, Disco will deploy the app automatically.
107+
And now, every time you `git push` new commits, disco will deploy the app automatically.
108108

109109
You can see the deployment output with:
110110
```bash

docs/get-started/set-up-your-server.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ You will also need a dedicated domain name for the server itself (in addition to
1212

1313
## Step One: disco init
1414

15-
First, you need to install Disco on your server. For this, you run `disco init` and you pass it the SSH `user@DOMAIN` to use for Disco.
15+
First, you need to install disco on your server. For this, you run `disco init` and you pass it the SSH `user@DOMAIN` to use for disco.
1616

1717

1818
For example, if the user is `root` and the domain is `disco.example.com`
@@ -22,7 +22,7 @@ disco init [email protected]
2222

2323
## Step Two: Add the Github app
2424

25-
Once Disco is installed, it will need to be connected to Github.
25+
Once disco is installed, it will need to be connected to Github.
2626

2727
Run
2828
```bash

docs/get-started/set-up-your-static-site-generator-site.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ sidebar_position: 6
44

55
# Set up your Static Site Generator (SSG)
66

7-
In this docs you will learn the basics to get your existing static site generator site building on Disco and being served by Disco. If you have a static site or running apps, refer to these sections instead.
7+
In this docs you will learn the basics to get your existing static site generator site building on disco and being served by disco. If you have a static site or running apps, refer to these sections instead.
88

99
## Overview
1010

11-
At this point, you already have installed the CLI on your computer, installed Disco on your server, and you have added your Disco Github app with the permissions to your repository on Github.
11+
At this point, you already have installed the CLI on your computer, installed disco on your server, and you have added your disco Github app with the permissions to your repository on Github.
1212

13-
In this guide, you will have a `Dockerfile` to build your site, and you'll have a `disco.json` file telling Disco where to find the files to be served within your image.
13+
In this guide, you will have a `Dockerfile` to build your site, and you'll have a `disco.json` file telling disco where to find the files to be served within your image.
1414

15-
### The site before Disco
15+
### The site before disco
1616

1717
Let's use a very barebone home made site generator as an example.
1818

@@ -72,7 +72,7 @@ python generate.py
7272

7373
### Create your Dockerfile
7474

75-
Static sites generator on Disco are built using a `Dockerfile`.
75+
Static sites generator on disco are built using a `Dockerfile`.
7676

7777
For this example, in Python, we'll use the official Python image from Docker Hub. Just create a file named `Dockerfile` at the root of your repository.
7878

@@ -88,7 +88,7 @@ See [notes below](#optimizing-the-dockerfile) for some optimizations we can make
8888

8989
### Create your disco.json
9090

91-
Create a file named `disco.json` at the root of your repository. The `disco.json` file tells Disco where to find the files to serve inside the Docker image we just built with the `Dockerfile` above.
91+
Create a file named `disco.json` at the root of your repository. The `disco.json` file tells disco where to find the files to serve inside the Docker image we just built with the `Dockerfile` above.
9292

9393
```json
9494
{
@@ -101,14 +101,14 @@ Create a file named `disco.json` at the root of your repository. The `disco.json
101101
}
102102
}```
103103

104-
The name `web` is a magic name. When Disco sees it, it knows that it's the one to use to expose to the internet, create a TLS certificate for HTTPS, etc.
104+
The name `web` is a magic name. When disco sees it, it knows that it's the one to use to expose to the internet, create a TLS certificate for HTTPS, etc.
105105

106106
`publicPath` is relative to the `WOKRDIR` in your `Dockerfile`. In our example, the directory `dist` actually means `/app/dist` in our Docker image.
107107

108108

109109
### That's it!
110110

111-
Your site is now ready to be deployed on Disco. You can use the CLI to add the project.
111+
Your site is now ready to be deployed on disco. You can use the CLI to add the project.
112112

113113
```bash
114114
disco projects:add \
@@ -117,7 +117,7 @@ disco projects:add \
117117
--domain first-site.example.com
118118
```
119119

120-
And now, every time you `git push` new commits, Disco will deploy the site automatically.
120+
And now, every time you `git push` new commits, disco will deploy the site automatically.
121121

122122
You can see the deployment output with:
123123
```bash

docs/get-started/set-up-your-static-site.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ sidebar_position: 5
44

55
# Set up your Static Site
66

7-
In this docs you will learn the basics to get your existing static site being served by Disco. If you have static files ready to serve, you're at the right place. If you're looking for static site generators or running apps, have a look at their sections in the docs.
7+
In this docs you will learn the basics to get your existing static site being served by disco. If you have static files ready to serve, you're at the right place. If you're looking for static site generators or running apps, have a look at their sections in the docs.
88

99
## Overview
1010

11-
At this point, you already have installed the CLI on your computer, installed Disco on your server, and you have added your Disco Github app with the permissions to your repository on Github.
11+
At this point, you already have installed the CLI on your computer, installed disco on your server, and you have added your disco Github app with the permissions to your repository on Github.
1212

13-
You already have static files to serve. You just need to tell Disco where to find them in your repository, by using a `disco.json` file.
13+
You already have static files to serve. You just need to tell disco where to find them in your repository, by using a `disco.json` file.
1414

15-
### The site before Disco
15+
### The site before disco
1616

1717
Let's say you have a folder called `public` that contains an HTML file `index.html`.
1818
```
@@ -38,7 +38,7 @@ public
3838

3939
### Create your disco.json
4040

41-
Create a file named `disco.json` at the root of your repository. The `disco.json` file tells Disco where to find your files.
41+
Create a file named `disco.json` at the root of your repository. The `disco.json` file tells disco where to find your files.
4242

4343
```json
4444
{
@@ -52,13 +52,13 @@ Create a file named `disco.json` at the root of your repository. The `disco.json
5252
}
5353
```
5454

55-
The name `web` is a magic name. When Disco sees it, it knows that it's the one to use to expose to the internet, create a TLS certificate for HTTPS, etc.
55+
The name `web` is a magic name. When disco sees it, it knows that it's the one to use to expose to the internet, create a TLS certificate for HTTPS, etc.
5656

5757
`publicPath` is relative to the root of your repository. In our example, the directory `public` sits at the root of the repository.
5858

5959
### That's it!
6060

61-
Your site is now ready to be deployed on Disco. You can use the CLI to add the project.
61+
Your site is now ready to be deployed on disco. You can use the CLI to add the project.
6262

6363
```bash
6464
disco projects:add \
@@ -67,7 +67,7 @@ disco projects:add \
6767
--domain first-site.example.com
6868
```
6969

70-
And now, every time you `git push` new commits, Disco will deploy the site automatically.
70+
And now, every time you `git push` new commits, disco will deploy the site automatically.
7171

7272
You can see the deployment output with:
7373
```bash

0 commit comments

Comments
 (0)