Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

XDOCKER-183: Fix Solr remote url property #31

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

XDOCKER-183: Fix Solr remote url property #31

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f54e989
XDOCKER-183: Fix Solr remote url property
acotiuga Mar 8, 2021
350cc9a
XDOCKER-183: Fix Solr remote url property #31
acotiuga Mar 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions 12/mysql-tomcat/xwiki/docker-entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,8 @@ function configure() {
file_env 'DB_PASSWORD' 'xwiki'
file_env 'DB_HOST' 'db'
file_env 'DB_DATABASE' 'xwiki'
file_env 'INDEX_HOST' 'localhost'
file_env 'INDEX_PORT' '8983'
file_env 'INDEX_BASEURL' 'http://localhost:8983/solr/xwiki'
file_env 'INDEX_TYPE' 'embedded'
Copy link
Member

@tmortagne tmortagne Mar 8, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't really understand why we need "INDEX_TYPE". Couldn't INDEX_BASEURL be an empty string by default and use that as criteria for example ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually forget that I'm fine with that since it's simply about following the standard configuration and someone might introduce a new type at some point.


echo " Deploying XWiki in the '$CONTEXT_PATH' context"
if [ "$CONTEXT_PATH" == "ROOT" ]; then
Expand Down Expand Up @@ -142,10 +142,10 @@ function configure() {
echo ' Configure libreoffice...'
xwiki_set_properties 'openoffice.autoStart' 'true'

if [ $INDEX_HOST != 'localhost' ]; then
if [ "$INDEX_TYPE" != 'embedded' ]; then
echo ' Configuring remote Solr Index'
xwiki_set_properties 'solr.type' 'remote'
xwiki_set_properties 'solr.remote.url' "http://$INDEX_HOST:$INDEX_PORT/solr/xwiki"
xwiki_set_properties 'solr.type' "$INDEX_TYPE"
xwiki_set_properties 'solr.remote.baseURL' "$INDEX_BASEURL"
fi

# If the files already exist then copy them to the XWiki's WEB-INF directory. Otherwise copy the default config
Expand Down
10 changes: 5 additions & 5 deletions 12/postgres-tomcat/xwiki/docker-entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,8 @@ function configure() {
file_env 'DB_PASSWORD' 'xwiki'
file_env 'DB_HOST' 'db'
file_env 'DB_DATABASE' 'xwiki'
file_env 'INDEX_HOST' 'localhost'
file_env 'INDEX_PORT' '8983'
file_env 'INDEX_BASEURL' 'http://localhost:8983/solr/xwiki'
file_env 'INDEX_TYPE' 'embedded'

echo " Deploying XWiki in the '$CONTEXT_PATH' context"
if [ "$CONTEXT_PATH" == "ROOT" ]; then
Expand Down Expand Up @@ -142,10 +142,10 @@ function configure() {
echo ' Configure libreoffice...'
xwiki_set_properties 'openoffice.autoStart' 'true'

if [ $INDEX_HOST != 'localhost' ]; then
if [ "$INDEX_TYPE" != 'embedded' ]; then
echo ' Configuring remote Solr Index'
xwiki_set_properties 'solr.type' 'remote'
xwiki_set_properties 'solr.remote.url' "http://$INDEX_HOST:$INDEX_PORT/solr/xwiki"
xwiki_set_properties 'solr.type' "$INDEX_TYPE"
xwiki_set_properties 'solr.remote.baseURL' "$INDEX_BASEURL"
fi

# If the files already exist then copy them to the XWiki's WEB-INF directory. Otherwise copy the default config
Expand Down
10 changes: 5 additions & 5 deletions 13/mysql-tomcat/xwiki/docker-entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,8 @@ function configure() {
file_env 'DB_PASSWORD' 'xwiki'
file_env 'DB_HOST' 'db'
file_env 'DB_DATABASE' 'xwiki'
file_env 'INDEX_HOST' 'localhost'
file_env 'INDEX_PORT' '8983'
file_env 'INDEX_BASEURL' 'http://localhost:8983/solr/xwiki'
file_env 'INDEX_TYPE' 'embedded'

echo " Deploying XWiki in the '$CONTEXT_PATH' context"
if [ "$CONTEXT_PATH" == "ROOT" ]; then
Expand Down Expand Up @@ -142,10 +142,10 @@ function configure() {
echo ' Configure libreoffice...'
xwiki_set_properties 'openoffice.autoStart' 'true'

if [ $INDEX_HOST != 'localhost' ]; then
if [ "$INDEX_TYPE" != 'embedded' ]; then
echo ' Configuring remote Solr Index'
xwiki_set_properties 'solr.type' 'remote'
xwiki_set_properties 'solr.remote.url' "http://$INDEX_HOST:$INDEX_PORT/solr/xwiki"
xwiki_set_properties 'solr.type' "$INDEX_TYPE"
xwiki_set_properties 'solr.remote.baseURL' "$INDEX_BASEURL"
fi

# If the files already exist then copy them to the XWiki's WEB-INF directory. Otherwise copy the default config
Expand Down
10 changes: 5 additions & 5 deletions 13/postgres-tomcat/xwiki/docker-entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,8 @@ function configure() {
file_env 'DB_PASSWORD' 'xwiki'
file_env 'DB_HOST' 'db'
file_env 'DB_DATABASE' 'xwiki'
file_env 'INDEX_HOST' 'localhost'
file_env 'INDEX_PORT' '8983'
file_env 'INDEX_BASEURL' 'http://localhost:8983/solr/xwiki'
file_env 'INDEX_TYPE' 'embedded'

echo " Deploying XWiki in the '$CONTEXT_PATH' context"
if [ "$CONTEXT_PATH" == "ROOT" ]; then
Expand Down Expand Up @@ -142,10 +142,10 @@ function configure() {
echo ' Configure libreoffice...'
xwiki_set_properties 'openoffice.autoStart' 'true'

if [ $INDEX_HOST != 'localhost' ]; then
if [ "$INDEX_TYPE" != 'embedded' ]; then
echo ' Configuring remote Solr Index'
xwiki_set_properties 'solr.type' 'remote'
xwiki_set_properties 'solr.remote.url' "http://$INDEX_HOST:$INDEX_PORT/solr/xwiki"
xwiki_set_properties 'solr.type' "$INDEX_TYPE"
xwiki_set_properties 'solr.remote.baseURL' "$INDEX_BASEURL"
fi

# If the files already exist then copy them to the XWiki's WEB-INF directory. Otherwise copy the default config
Expand Down
17 changes: 8 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -423,18 +423,18 @@ From the [XWiki Solr Search API documentation](https://extensions.xwiki.org/xwik
>
> You can also find more Solr-specific performance details on https://wiki.apache.org/solr/SolrPerformanceProblems. Standalone Solr also comes with a very nice UI, along with monitoring and test tools.

This image provides the configuration parameters `INDEX_HOST` and `INDEX_PORT` which are used to configure `xwiki.properties` with:
This image provides the configuration parameters `INDEX_BASEURL` and `INDEX_TYPE` which are used to configure `xwiki.properties` with:

```data
solr.type=remote
solr.remote.url=http://$INDEX_HOST:$INDEX_PORT/solr/xwiki
solr.type=$INDEX_TYPE
solr.remote.baseURL=$INDEX_BASEURL
```

#### Preparing Solr container

The simplest way to create an external Solr service is using the [official Solr image](https://hub.docker.com/_/solr/).

- Select the appropriate XWiki Solr configuration JAR from [here](https://maven.xwiki.org/releases/org/xwiki/platform/xwiki-platform-search-solr-server-data/) (Note: it's usually better to synchronize it with your version of XWiki)
- Select the appropriate XWiki Solr configuration JAR from [here](https://maven.xwiki.org/releases/org/xwiki/platform/xwiki-platform-search-solr-server-core/) (Note: it's usually better to synchronize it with your version of XWiki)
- Place this JAR in a directory along side `solr-init.sh` that you can fetch from the [docker-xwiki repository](https://github.com/xwiki-contrib/docker-xwiki/tree/master/contrib/solr)
- Ensure that this directory is owned by the Solr user and group `chown -R 8983:8983 /path/to/solr/init/directory`
- Launch the Solr container and mount this directory at `/docker-entrypoint-initdb.d`
Expand All @@ -456,7 +456,7 @@ docker run \
-d solr:7.2
```

Then start the XWiki container, the below command is nearly identical to that specified in the Starting XWiki section above, except that it includes the `-e INDEX_HOST=` environment variable which specifies the hostname of the Solr container.
Then start the XWiki container, the below command is nearly identical to that specified in the Starting XWiki section above, except that it includes the `-e INDEX_BASEURL=` environment variable which specifies the baseURL of the Solr container.

```console
docker run \
Expand All @@ -468,7 +468,7 @@ docker run \
-e DB_PASSWORD=xwiki \
-e DB_DATABASE=xwiki \
-e DB_HOST=mysql-xwiki \
-e INDEX_HOST=solr-xwiki \
-e INDEX_BASEURL=http://localhost:8983/solr/xwiki \
-d xwiki:lts-mysql-tomcat
```

Expand Down Expand Up @@ -496,7 +496,7 @@ services:
- DB_PASSWORD=xwiki
- DB_DATABASE=xwiki
- DB_HOST=xwiki-db
- INDEX_HOST=xwiki-index
- INDEX_BASEURL=http://localhost:8983/solr/xwiki
volumes:
- xwiki-data:/usr/local/xwiki
networks:
Expand Down Expand Up @@ -586,8 +586,7 @@ The first time you create a container out of the xwiki image, a shell script (`/
- `DB_PASSWORD`: The user password used by XWiki to read/write to the DB.
- `DB_DATABASE`: The name of the XWiki database to use/create.
- `DB_HOST`: The name of the host (or docker container) containing the database. Default is "db".
- `INDEX_HOST`: The hostname of an externally configured Solr instance. Defaults to "localhost", and configures an embedded Solr instance.
- `INDEX_PORT`: The port used by an externally configured Solr instance. Defaults to 8983.
- `INDEX_BASEURL`: The base URL of an externally configured Solr instance. Defaults to "http://localhost:8983/solr/xwiki", and configures an embedded Solr instance
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would fail the official dockerhub image best practices. It requires a tab.

- `CONTEXT_PATH`: The name of the context path under which XWiki will be deployed in Tomcat. If not specified then it'll be deployed as ROOT.
- If you had set this environment property and later on, recreate the XWiki container without passing it (i.e you wish to deploy XWiki as ROOT again), the you'll need to edit the `xwiki.cfg` file in your mapped local permanent directory and set `xwiki.webapppath=`.

Expand Down
10 changes: 5 additions & 5 deletions template/xwiki/docker-entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,8 @@ function configure() {
file_env 'DB_PASSWORD' 'xwiki'
file_env 'DB_HOST' 'db'
file_env 'DB_DATABASE' 'xwiki'
file_env 'INDEX_HOST' 'localhost'
file_env 'INDEX_PORT' '8983'
file_env 'INDEX_BASEURL' 'http://localhost:8983/solr/xwiki'
file_env 'INDEX_TYPE' 'embedded'

echo " Deploying XWiki in the '\$CONTEXT_PATH' context"
if [ "\$CONTEXT_PATH" == "ROOT" ]; then
Expand Down Expand Up @@ -142,10 +142,10 @@ function configure() {
echo ' Configure libreoffice...'
xwiki_set_properties 'openoffice.autoStart' 'true'

if [ \$INDEX_HOST != 'localhost' ]; then
if [ "\$INDEX_TYPE" != 'embedded' ]; then
echo ' Configuring remote Solr Index'
xwiki_set_properties 'solr.type' 'remote'
xwiki_set_properties 'solr.remote.url' "http://\$INDEX_HOST:\$INDEX_PORT/solr/xwiki"
xwiki_set_properties 'solr.type' "\$INDEX_TYPE"
xwiki_set_properties 'solr.remote.baseURL' "\$INDEX_BASEURL"
fi

# If the files already exist then copy them to the XWiki's WEB-INF directory. Otherwise copy the default config
Expand Down