Skip to content

Commit d6d9001

Browse files
committed
Update docker compose commands, since it is now part of the docker CLI
1 parent 39bae12 commit d6d9001

File tree

2 files changed

+17
-18
lines changed

2 files changed

+17
-18
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ bundle exec rails test
113113

114114
or if using docker:
115115
```
116-
docker-compose run test
116+
docker compose run test
117117
```
118118

119119
You can also see the test coverage % after the tests finish - make sure it has not decreased from before adding your code.
@@ -154,7 +154,6 @@ TeSS has various levels of documentation that can also be contributed to:
154154

155155
Small changes can be made directly in GitHub. Simply open the relevant file, click the pencil icon to edit, make your change, and click the "Proprose changes" button - GitHub will automatically create a fork, a feature branch and a pull request for you.
156156

157-
158157
# Thank You
159158

160159
Thank you for considering contributing to TeSS.

docs/docker.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,12 @@ Create TeSS configuration files:
4242

4343
### Install gems and set up the database (migrations + seed data + create admin user)
4444

45-
docker-compose run app bundle install
46-
docker-compose run app bundle exec rake db:setup
45+
docker compose run app bundle install
46+
docker compose run app bundle exec rake db:setup
4747

4848
### Start services
4949

50-
docker-compose up -d
50+
docker compose up -d
5151

5252
### Access TeSS
5353

@@ -59,35 +59,35 @@ TeSS is accessible at the following URL:
5959

6060
The full test suite can be run using the following command:
6161

62-
docker-compose run test
62+
docker compose run test
6363

6464
To run a specific test, you can override the command being passed:
6565

66-
docker-compose run test rails test test/models/event_test.rb
66+
docker compose run test rails test test/models/event_test.rb
6767

6868
### Solr
6969

7070
To force Solr to reindex all documents, you can run the following command:
7171

72-
docker-compose exec app bundle exec rake tess:reindex
72+
docker compose exec app bundle exec rake tess:reindex
7373

7474
### Additional development commands
7575

7676
Install gems
7777

78-
docker-compose exec app bundle install
78+
docker compose exec app bundle install
7979

8080
Update all Gems
8181

82-
docker-compose exec app bundle update --all
82+
docker compose exec app bundle update --all
8383

8484
Update specific Gem
8585

86-
docker-compose exec app bundle update <gem>
86+
docker compose exec app bundle update <gem>
8787

8888
Rebuild the tess-app image when composing up.
8989

90-
docker-compose up -d --build
90+
docker compose up -d --build
9191

9292
## Production
9393

@@ -112,26 +112,26 @@ Setup the TeSS configuration files:
112112

113113
`tess.yml` is used to configure features and branding of your TeSS instance. `secrets.yml` is used to hold API keys etc.
114114

115-
The production deployment is configured in the `docker-compose-prod.yml` file.
115+
The production deployment is configured in the `docker compose-prod.yml` file.
116116

117117
Start services:
118118

119-
docker-compose -f docker-compose-prod.yml up -d
119+
docker compose -f docker compose-prod.yml up -d
120120

121121
Run initial database setup:
122122

123-
docker-compose -f docker-compose-prod.yml exec app bundle exec rake db:setup DISABLE_DATABASE_ENVIRONMENT_CHECK=1
123+
docker compose -f docker compose-prod.yml exec app bundle exec rake db:setup DISABLE_DATABASE_ENVIRONMENT_CHECK=1
124124

125125
### Other production tasks
126126

127127
Run database migrations:
128128

129-
docker-compose -f docker-compose-prod.yml exec app bundle exec rake db:migrate
129+
docker compose -f docker compose-prod.yml exec app bundle exec rake db:migrate
130130

131131
Precompile the assets, necessary if any CSS/JS/images are changed after building the image:
132132

133-
docker-compose -f docker-compose-prod.yml exec app bundle exec rake assets:clean && bundle exec rake assets:precompile
133+
docker compose -f docker compose-prod.yml exec app bundle exec rake assets:clean && bundle exec rake assets:precompile
134134

135135
Reindex Solr:
136136

137-
docker-compose -f docker-compose-prod.yml exec app bundle exec rake tess:reindex
137+
docker compose -f docker compose-prod.yml exec app bundle exec rake tess:reindex

0 commit comments

Comments
 (0)