Skip to content

Commit cd33aff

Browse files
committed
Some readme tweaks
1 parent 1ee5f7c commit cd33aff

1 file changed

Lines changed: 40 additions & 40 deletions

File tree

‎README.md‎

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

33
[![Join the chat at https://gitter.im/dokku-alt/dokku-alt](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dokku-alt/dokku-alt?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
44

5-
Docker powered mini-Heroku. The smallest PaaS implementation you've ever seen. It's fork of original [dokku](https://github.com/progrium/dokku). The idea behind this fork is to provide complete solution with plugins covering most of use-cases which are stable and well tested.
5+
Docker powered mini-Heroku. The smallest PaaS implementation you've ever seen. It's a fork of the original [dokku](https://github.com/progrium/dokku). The idea behind this fork is to provide complete solution with plugins covering most use-cases which are stable and well tested.
66

77
## Features
88

@@ -43,21 +43,21 @@ Docker powered mini-Heroku. The smallest PaaS implementation you've ever seen. I
4343

4444
## Requirements
4545

46-
Assumes that you use Ubuntu 14.04 LTS right now. Ideally have a domain ready to point to your host. It's designed for and is probably best to use a fresh VM. The debian package will install everything it needs.
46+
Assumes that you use Ubuntu 14.04 LTS right now. Ideally, you should have a domain ready to point to your host. It's designed for and is probably best to use a fresh VM. The debian package will install everything it needs.
4747

4848
## Installing
4949

5050
$ sudo bash -c "$(curl -fsSL https://raw.githubusercontent.com/dokku-alt/dokku-alt/master/bootstrap.sh)"
5151

5252
## Installing (with force-yes)
5353

54-
Sometimes you may want to install dokku-alt completely non-interactive way. Now you can do it. Simply boostrap.sh without terminal:
54+
Sometimes you may want to install dokku-alt in a completely non-interactive way. Now you can do it. Simply boostrap.sh without terminal:
5555

5656
$ sudo bash -c "$(curl -fsSL https://raw.githubusercontent.com/dokku-alt/dokku-alt/master/bootstrap.sh)" < /dev/null
5757

5858
## Configuring
5959

60-
If you use bootstrap script from above at the end it will fireup ruby installation script. Point your browser to `http://<ip>:2000/` and finish configuration.
60+
If you use the bootstrap script from above, at the end it will fireup ruby installation script. Point your browser to `http://<ip>:2000/` and finish configuration.
6161

6262
That's it!
6363

@@ -71,13 +71,13 @@ You'll have to add a public key associated with a username by doing something li
7171

7272
## Upgrade and beta releases
7373

74-
Unlike `dokku` this script uses debian packaging system (deb). To upgrade to latest version simply execute: `sudo apt-get update && sudo apt-get install dokku-alt`.
74+
Unlike `dokku`, this script uses the debian packaging system (deb). To upgrade to the latest version, simply execute: `sudo apt-get update && sudo apt-get install dokku-alt`.
7575

7676
Alongside the normal (stable) releases we distribute as well beta (bleeding edge). To switch to beta simply execute: `sudo apt-get update && sudo apt-get install dokku-alt-beta`. It will replace the stable dokku-alt and switch to beta.
7777

7878
## Migration from dokku
7979

80-
It should be possible, it should mostly work, but it's not tested and advised. VPS are very cheap this days so fire-up new machine and setup `dokku-alt` from the scratch.
80+
It should be possible, it should mostly work, but it's not tested and advised. VPS's are very cheap this days so fire-up new machine and setup `dokku-alt` from scratch.
8181

8282
## Deploy an App
8383

@@ -108,11 +108,11 @@ Please check the documentation for your particular build pack as you may need to
108108

109109
## Dokku-alt-manager
110110

111-
It's web interface to easily manage your dokku-alt instance. Simply run to install manager:
111+
It's a web interface to easily manage your dokku-alt instance. To install manager, simply run:
112112

113113
dokku manager:install
114114

115-
Anytime you can enable or disable it:
115+
You can enable or disable it anytime:
116116

117117
dokku manager:enable
118118
dokku manager:disable
@@ -123,7 +123,7 @@ Or even uninstall if you prefer command line access (it will also wipe used data
123123

124124
## Dokku-alt as service in Docker container (BETA)
125125

126-
Dokku-alt can be run using Docker-in-Docker approach (https://github.com/jpetazzo/dind). It requires to run dokku-alt container in privileged mode (with full access to host), because dokku-alt uses it's own Docker daemon to serve applications. It's still considered beta, but should be pretty safe solution and robust. It's best to use for play with dokku-alt on other not-supported systems (CentOS, RedHat, Debian) or by simply trying how it works.
126+
Dokku-alt can be run using Docker-in-Docker approach (https://github.com/jpetazzo/dind). It requires you to run the dokku-alt container in privileged mode (with full access to host), because dokku-alt uses its own Docker daemon to serve applications. It's still considered beta, but should be pretty safe solution and robust. It's best to use for play with dokku-alt on other not-supported systems (CentOS, RedHat, Debian) or by simply trying how it works.
127127

128128
All dokku-alt services (SSH, Nginx, Dokku daemon) are run in container.
129129

@@ -135,27 +135,27 @@ All dokku-alt services (SSH, Nginx, Dokku daemon) are run in container.
135135

136136
docker run -d --name=dokku-alt --hostname=my-domain.com --volumes-from=dokku-alt-data --publish=22:22 --publish=80:80 --publish=443:443 --privileged ayufan/dokku-alt:latest
137137

138-
You can adjust exposed ports as described in Docker documentation.
138+
You can adjust the exposed ports as described in Docker documentation.
139139

140140
### Check `dokku-alt` logs to see if anything started correctly:
141141

142142
docker logs dokku-alt-demo
143143

144-
At the end you should see something like this:
144+
At the end, you should see something like this:
145145

146146
dokku.1 | SSH Login:
147147
dokku.1 | user: root
148148
dokku.1 | password: lfMUjxYEvqpRRLY6
149149
dokku.1 | ip: 10.0.42.1 172.17.2.213
150150
dokku.1 | Starting dokku daemon...
151151

152-
This is temporary `root` password to access container and add you access keys (using `dokku access:add` as described). This password changes every container restart.
152+
This is a temporary `root` password to access the container and add your access keys (using `dokku access:add` as described). This password changes every container restart.
153153

154-
To enter container shell from server's terminal (the same which is running `docker` with `dokku-alt`) run ssh:
154+
To enter the container shell from the server's terminal (the same which is running `docker` with `dokku-alt`) run ssh:
155155

156156
ssh root@172.17.2.213
157157

158-
If everything were done right you should see container's prompt. By exposing ports in `docker run` to outside world you can also access `dokku-alt` from external.
158+
If everything was done right, you should see the container's prompt. By exposing ports in `docker run` to the outside world you can also access `dokku-alt` externally.
159159

160160
### To upgrade container to newer version simply kill old container and rerun your `docker run` command:
161161

@@ -165,18 +165,18 @@ If everything were done right you should see container's prompt. By exposing por
165165

166166
## Dockerfile images
167167

168-
The key feature of the `dokku-alt` is built-in support for Dockerfiles, the docker build process. It allows you to create more advanced and more repetitive application environments.
168+
The key feature of `dokku-alt` is built-in support for Dockerfiles, the docker build process. It allows you to create more advanced and more repetitive application environments.
169169
To use `Dockerfile` simply put `Dockerfile` in root of the application, `dokku-alt` will detect it and build application according to specification in `Dockerfile`.
170170

171-
Dockerfile-based application can (but not required) to expose web-application port. `dokku-alt` will check if 80, 8080, 5000 is exposed. If it's it will update assign vhost and reconfigure nginx to forward all incoming traffic.
171+
Dockerfile-based application can (but not required) expose a web-application port. `dokku-alt` will check if port 80, 8080 or 5000 is exposed. If it is, it will update the assigned vhost and reconfigure nginx to forward all incoming traffic.
172172

173-
Using dockerfile you can built service-only applications. Simply don't expose public facing ports.
173+
Using Dockerfile, you can build service-only applications. Simply don't expose any public facing ports.
174174

175175
Example Dockerfile application: https://github.com/ayufan/dokku-alt-phpmyadmin
176176

177177
## Nginx and redirects
178178

179-
Dokku-alt has built-in support for additional domains and url redirects. By specifying redirects any client using that address will automatically be redirected to first domain assigned to the application.
179+
Dokku-alt has built-in support for additional domains and url redirects. By specifying redirects, any client using that address will automatically be redirected to the first domain assigned to the application.
180180

181181
## Remote commands
182182

@@ -202,19 +202,19 @@ SSH onto the server, then execute:
202202

203203
## Create-only application
204204

205-
Dokku-alt allows you to create application before pushing it. It can be useful when you want to specify additional config variables or assign databases. Simply execute:
205+
Dokku-alt allows you to create an application before pushing it. It can be useful when you want to specify additional config variables or assign databases. Simply execute:
206206

207207
$ dokku create mynewapp
208208

209-
There's also possiblity to disable auto-application creation on push. Add to `~/dokkurc`:
209+
It's also possible to disable auto-application creation on push. Add to `~/dokkurc`:
210210

211211
export DOKKU_DISABLE_AUTO_APP_CREATE=1
212212

213-
From now on you will have to do `dokku create` at first.
213+
From now on you will have to do `dokku create` before pushing.
214214

215215
## Allowing push-access (deploy only) access for dokku
216216

217-
Dokku-alt allows you to add additional public keys to applications. The specific case is to add special deploy-only key, used for example by Countinous Integration (ie. Jenkins). Key added as deploy-only can only be used to `git push` specific application. It will not allowed to execute any on `dokku` commands. You can add ssh key and allow it explicit access to one or many applications.
217+
Dokku-alt allows you to add additional public keys to applications. The specific case is to add special deploy-only key, used for example by Countinous Integration (ie. Jenkins). Key added as deploy-only can only be used to `git push` specific application. It will not allowed to execute any `dokku` commands. You can add an ssh key and give it explicit access to one or many applications.
218218

219219
Add locally:
220220

@@ -242,7 +242,7 @@ Revoke permissions for admin user:
242242

243243
## Environment variable management
244244

245-
Typically an application will require some environment variables to run properly. Environment variables may contain private data, such as passwords or API keys, so it is not recommend to store them in your application's repository.
245+
Typically, an application will require some environment variables to run properly. Environment variables may contain private data, such as passwords or API keys, so it is not recommend to store them in your application's repository.
246246

247247
The `config` plugin provides the following commands to manage your variables:
248248
```
@@ -255,13 +255,13 @@ config:unset <app> KEY1 [KEY2 ...] - unset one or more config vars
255255
### Available environment variables
256256

257257
* `DOKKU_NGINX_PROXY_READ_TIMEOUT` - allows to override `nginx proxy_read_timeout`. Default value is set to '60s'. For more info please refer to: http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_read_timeout.
258-
* `DOKKU_ENABLE_HTTP_HOST` - when set to 1 application will also serve content on HTTP if HTTPS is enabled
259-
* `DOKKU_BUILDSTEP_IMAGE` - allows you to set custom buildstep image on per app basis. Image has to be compatible with https://github.com/progrium/buildstep or https://github.com/dokku-alt/progrium-buildstep-dockerfiles. In case of image forked from https://github.com/progrium/buildstep there might be small incompatibility: image is run with `/start` instead of `/start web` as in orginal `dokku`.
258+
* `DOKKU_ENABLE_HTTP_HOST` - when set to 1, the application will also serve content on HTTP if HTTPS is enabled
259+
* `DOKKU_BUILDSTEP_IMAGE` - allows you to set a custom buildstep image on per app basis. Image has to be compatible with https://github.com/progrium/buildstep or https://github.com/dokku-alt/progrium-buildstep-dockerfiles. If the images was forked from https://github.com/progrium/buildstep, there might be a small incompatibility: the image is run with `/start` instead of `/start web` as in orginal `dokku`.
260260
* `DOKKU_START_CMD` - allows you to set a custom start command. The default value is `/start` for buildstep images and ` ` otherwise.
261261

262262
## Image tagging
263263

264-
When you successfully deploy an app, you can tag it with your name and later in case of failure quickly revert back to that image.
264+
When you successfully deploy an app, you can tag it with a name/version. This lets you quickly roll back to that image in the event of failure in a later deployment.
265265

266266
$ dokku tag:add gitlab v6.9.0
267267
=====> Tagged latest image of dokku/gitlab as v6.9.0
@@ -278,12 +278,12 @@ When you successfully deploy an app, you can tag it with your name and later in
278278

279279
Dokku-alt has built-in support for all modern database engines: MariaDB (former MySQL), PostgreSQL and MongoDB. The database image will be downloaded and provisioned when first used.
280280

281-
First create database:
281+
First create a database:
282282

283283
$ dokku mariadb:create test-db
284284
-----> MariaDB database created: test-db
285285

286-
Second link database to an app:
286+
Second link the database to an app:
287287

288288
$ dokku mariadb:link node-js-sample test-db
289289
-----> Releasing node-js-sample ...
@@ -292,19 +292,19 @@ Second link database to an app:
292292
=====> Application deployed:
293293
http://node-js-sample.ayufan.eu
294294

295-
Verify application env variables:
295+
Verify the application environment variables:
296296

297297
$ dokku config node-js-sample
298298
=== node-js-sample config vars ===
299299
DATABASE_URL: mysql2://node-js-sample:random-password@mariadb:3306/test-db
300300

301-
To use different database engine simple replace `mariadb` with `postgresql` or `mongodb`.
301+
To use a different database engine, simply replace `mariadb` with `postgresql` or `mongodb`.
302302

303303
## Preboot / zero-downtime boot
304304

305-
Similar to functionality provided by https://devcenter.heroku.com/articles/labs-preboot `dokku-alt` supports zero-downtime. To enable zero-downtime deployment execute command: `dokku preboot:enable APP`. Alongside with preboot there's `checks` plugin based on https://labnotes.org/zero-downtime-deploy-with-dokku/. For now it simply checks if application started serving requests. If checks module fails it will not replace the application.
305+
Similar to functionality provided by https://devcenter.heroku.com/articles/labs-preboot `dokku-alt` supports zero-downtime. To enable zero-downtime deployment, execute command: `dokku preboot:enable APP`. Alongside with preboot, there's a `checks` plugin based on https://labnotes.org/zero-downtime-deploy-with-dokku/. For now, it simply checks if the application started serving requests. If the checks module fails, it will not replace the application.
306306

307-
Preboot and checks can be configured using a few env variables:
307+
Preboot and checks can be configured using a few environment variables:
308308

309309
* PREBOOT_WAIT_TIME - number of seconds to wait for container boot (default 5s)
310310
* PREBOOT_COOLDOWN_TIME - number of seconds to wait finish container request processing (default 30s)
@@ -314,14 +314,14 @@ Preboot and checks can be configured using a few env variables:
314314

315315
## Data volumes
316316

317-
Docker allows you to have persistent data storage. Dokku-alt exposes this feature as Data Volumes. You can create unlimited number of data volumes, any data volume can be attached to unlimited number of apps. Simply create data volume and specify container paths which you want to be persistant.
317+
Docker allows you to have persistent data storage. Dokku-alt exposes this feature as Data Volumes. You can create unlimited number of data volumes and any data volume can be attached to unlimited number of apps. Simply create a data volume and specify container paths which you want to be persistant.
318318

319-
First data volume:
319+
First, create a data volume:
320320

321321
$ dokku volume:create shared-test-volume /app/logs /app/tmp /app/uploads
322322
-----> Volume created: volume_data_shared-test-volume
323323

324-
Second link volume to an app:
324+
Second, link the volume to an app:
325325

326326
$ dokku volume:link node-js-sample shared-test-volume
327327
-----> Volume shared-test-volume linked to an aplication: node-js-sample
@@ -335,7 +335,7 @@ It is just simple as this.
335335

336336
### Host-based volumes
337337

338-
Dokku-alt allows you to bind host-based volumes in very simple manner. To use this feature you have to be logged as `root` and than simply type:
338+
Dokku-alt allows you to bind host-based volumes in a very simple manner. To use this feature, you have to be logged as `root` and then simply type:
339339

340340
dokku volume:create host-based-volume /path/to/host/volume:/path/to/volume/in/container
341341

@@ -347,11 +347,11 @@ Dokku-alt allows you to secure any application with HTTP-Basic Auth. There are a
347347
htpasswd:disable <app> Remove http-basic Auth
348348
htpasswd:remove <app> <user> Remove user
349349

350-
If you want to enable and add a new user simply type command below and when prompted type your password twice:
350+
If you want to enable and add a new user, simply type the command below and when prompted, type your password twice:
351351

352352
dokku htpasswd:add myapp myuser
353353

354-
You can also pipe password:
354+
You can also pipe the password:
355355

356356
echo mypass | dokku htpasswd:add myapp myuser
357357

@@ -365,7 +365,7 @@ To remove HTTP-Basic Auth completely:
365365

366366
## TLS support
367367

368-
Dokku provides easy TLS support from the box. To enable TLS connection to your application, copy the `.crt` and `.key` files into the `/home/dokku/:app/ssl` folder (notice, file names should be `server.crt` and `server.key`, respectively). Redeployment of the application will be needed to apply TLS configuration. Once it is redeployed, the application will be accessible by `https://` (redirection from `http://` is applied as well).
368+
Dokku provides easy TLS support out of the box. To enable TLS connection to your application, copy the `.crt` and `.key` files into the `/home/dokku/:app/ssl` folder (notice, file names should be `server.crt` and `server.key`, respectively). Redeployment of the application will be needed to apply TLS configuration. Once it's redeployed, the application will be accessible by `https://` (redirection from `http://` is applied as well).
369369

370370
## TLS support
371371

@@ -562,7 +562,7 @@ You can use [Github Issues](https://github.com/dokku-alt/dokku-alt/issues).
562562

563563
"I deployed my Rails application on a fresh new machine using dokku-alt but I already own a bare metal, replicated PostgreSQL server that's reachable from the dokku host as it's on the same network. How do I connect?"
564564

565-
Run the follwing:
565+
Run the following:
566566

567567
dokku config:set <app> DATABASE_URL=postgresql://user:password@dbserver-ip:5432/DBNAME
568568

0 commit comments

Comments
 (0)