/
README
49 lines (29 loc) · 1.9 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
= mediawiki-testwiki - MediaWiki test wikis based on Docker
== VERSION
This documentation refers to mediawiki-testwiki version 0.0.2.
== DESCRIPTION
Provides pre-configured MediaWiki wikis as Docker images as well as an RSpec
adapter to integrate with your specs (see MediaWiki::TestWiki::RSpecAdapter).
== USAGE
0. To _use_ the Docker images, point Docker at +blackwinter/mediawiki-testwiki+ (and possibly a {specific version}[https://hub.docker.com/r/blackwinter/mediawiki-testwiki/tags]).
0. To _test_ your project against a MediaWiki instance using RSpec, use the MediaWiki::TestWiki::RSpecAdapter; see mediawiki-gateway[https://github.com/jpatokal/mediawiki-gateway/blob/27ef552/spec/spec_helper.rb#L24-L32] for an example.
0. To _build_ new Docker images, e.g. for different MediaWiki versions, use the Rake tasks provided in the +docker/+ directory: <tt>rake build VERSION=x.y.z</tt>.
== LINKS
Docker images:: https://hub.docker.com/r/blackwinter/mediawiki-testwiki
Documentation:: https://blackwinter.github.com/mediawiki-testwiki
Source code:: https://github.com/blackwinter/mediawiki-testwiki
RubyGem:: https://rubygems.org/gems/mediawiki-testwiki
== AUTHORS
* Jens Wille <mailto:jens.wille@gmail.com>
== LICENSE AND COPYRIGHT
Copyright (C) 2014 Jens Wille
mediawiki-testwiki is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or (at your
option) any later version.
mediawiki-testwiki is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
License for more details.
You should have received a copy of the GNU Affero General Public License
along with mediawiki-testwiki. If not, see <http://www.gnu.org/licenses/>.