Simplifying Foswiki and Solr with Docker

Running Foswiki and Solr with cutting edge features has never been easier!

With Docker (and docker-compose) preparing a fully functional production quality Foswiki and Solr environment is simple and easy.

Docker Underlying File System Type

Before you proceed run the following command to ensure your underlying filesystem supports d_type. Docker requires this if the storage driver is overlay2 and the host file system is xfs

docker info 

Storage Driver: overlay2
 Backing Filesystem: xfs
 Supports d_type: true

If d_type is false you need to recreate your mount point for docker volumes see Docker on CentOS 7 machine with XFS filesystem can cause trouble when d_type is not supported

Solr Server

Solr Server is automatically installed with docker-compose, configured and started

Starting Foswiki and Solr

Check out timlegge/docker-foswiki

git clone https://github.com/timlegge/docker-foswiki.git
cd docker-foswiki

Start Foswiki and Solr

docker-compose up

Resetting the Admin Password

docker exec -it docker-foswiki_foswiki_1 /bin/bash

cd /var/www/foswiki/
tools/configure -save -set {Password}='MyPassword'

Testing Solr within Foswiki

docker exec -it docker-foswiki_foswiki_1 /bin/bash

cd /var/www/foswiki/tools/
./solrindex topic=Main.WebHome

cd /var/www/foswiki/bin
./rest /SolrPlugin/search | grep Congrat

The solrindex command will complain about the lack of a .htpasswd file but should show Indexing topic Main.WebHome. The rest command should search using Solr and grep for congratulations that shows on the Main.WebHome

Enable Solr Search on Foswiki

1. Connect to http://localhost:8765/
2. Login as the admin user (username: admin, password: [as set above])
3. Access http://localhost:8765/bin/configure
4. Access Extensions
5. Configure AutoTemplatePlugin
6. Modify ViewTemplate Rules
   1. Change 'WebSearch' => 'WebSearchView' to 'WebSearch' => 'SolrSearchView'
7. Save Configuration Changes
8. Connect to http://localhost:8765/
9. Click Search
   1. Type "Congrat" (you should see Main begin to appear)
   2. Press Enter (you should see the Solr results for "Congrat" search term)

Solr Admin interface access

To reduce vulnerabilities, the Solr application listens only on the docker Foswiki network that is shared with the Foswiki container. Foswiki can connect to the Solr container but unless you absolutely need to access the admin interface you should not make Solr available on the host server.

See Overriding Defaults using an overrides yaml file or add a ports section to the docker-compose.yaml file under the solr section forwarding 8983:8983.

Starting Foswiki with a non-default port

By default, docker-compose.yaml settings makes Foswiki to listen on port 8765/tcp. This allows you to run Foswiki and Solr on a server that is already listenning on port 80.

See Overriding Defaults using an overrides yaml file or use the FOSWIKI_PORT environment variable :

FOSWIKI_PORT=80 docker-compose up

Starting multiple Foswiki

Docker will allow multiple instances of Foswiki+Solr to run simultaneously and totally independently from each other on the same machine, with the only limit of hardware resources.

See Running multiple Instances using the docker-compose -p projectName, possibly with overides yaml files:

docker-compose -p project1 -f docker-compose.yaml -f overrides-project1.yml up
docker-compose -p project2 -f docker-compose.yaml -f overrides-project2.yml up

Next Steps

At this point you have a working Foswiki and Solr installation. The following would be normal next steps:

1. Configure Foswiki as you would like
2. Convert data
3. Setup or configure an nginx proxy 80/443 to port 8765

Included Foswiki Features

Foswiki Contribs

1. CopyContrib
2. DBCacheContrib
3. FarscrollContrib
4. InfiniteScrollContrib
5. JQAutoColorContrib
6. JQMomentContrib
7. JQPhotoSwipeContrib
8. JQSelect2Contrib
9. JQSerialPagerContrib
10. JQTwistyContrib
11. JSTreeContrib
12. LdapContrib
13. StringifierContrib
14. WebFontsContrib
15. XSendFileContrib

Foswiki Plugins

1. AttachContentPlugin
2. AutoRedirectPlugin
3. AutoTemplatePlugin
4. BreadCrumbsPlugin
5. CaptchaPlugin
6. ClassificationPlugin
7. DBCachePlugin
8. DiffPlugin
9. DigestPlugin
10. DocumentViewerPlugin
11. EditChapterPlugin
12. FilterPlugin
13. FlexFormPlugin
14. FlexWebListPlugin
15. GraphvizPlugin
16. GridLayoutPlugin
17. ImageGalleryPlugin
18. ImagePlugin
19. JQDataTablesPlugin
20. LdapNgPlugin
21. LikePlugin
22. ListyPlugin
23. MediaElementPlugin
24. MetaCommentPlugin
25. MetaDataPlugin
26. MimeIconPlugin
27. MoreFormfieldsPlugin
28. MultiLingualPlugin
29. NatSkinPlugin
30. NewUserPlugin
31. PageOptimizerPlugin
32. PubLinkFixupPlugin
33. RedDotPlugin
34. RenderPlugin
35. SecurityHeadersPlugin
36. SolrPlugin
37. TagCloudPlugin
38. TopicInteractionPlugin
39. TopicTitlePlugin
40. WebLinkPlugin
41. WorkflowPlugin

Foswiki Skin

1. NatSkin

Credits

1. timlegge/docker-foswiki is based on the original work of michael34435/docker-foswiki
2. The Alpine Linux project was very helpful in approving the required perl-modules that were submitted (full native packages to support Foswiki)
3. Solr and their docker container simplified Solr setup
4. Michel Mallejac contributed the docker-compose.yaml to bring it all together