diff --git a/.github/workflows/create-docker-image.yml b/.github/workflows/create-docker-image.yml index 3a9085c6239..a9336d16e86 100644 --- a/.github/workflows/create-docker-image.yml +++ b/.github/workflows/create-docker-image.yml @@ -1,4 +1,4 @@ -name: create-docker-image +name: Create Docker Image on: workflow_run: workflows: [release] @@ -18,6 +18,10 @@ jobs: uses: actions/checkout@v4 with: ref: ${{ github.event_name == 'workflow_dispatch' && github.workflow_dispatch.ref || github.event.workflow_run.head_branch }} + - name: Set up QEMU + uses: docker/setup-qemu-action@v3 + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 - name: Login to ghcr.io to upload sailing-analytics image uses: docker/login-action@v3 with: @@ -54,8 +58,13 @@ jobs: with: build-args: RELEASE=${{ env.RELEASE }} tags: ghcr.io/sap/sailing-analytics:${{ env.RELEASE }}${{ env.BRANCH == 'main' && github.event.inputs.release == '' && ',ghcr.io/sap/sailing-analytics:latest' || env.BRANCH == 'docker-17' && github.event.inputs.release == '' && ',ghcr.io/sap/sailing-analytics:latest-17' || '' }} + annotations: | + maintainer=axel.uhl@sap.com + index:org.opencontainers.image.title=Sailing Analytics + index:org.opencontainers.image.description=The Sailing Analytics Web Application file: ${{ env.BRANCH == 'docker-17' && 'docker/Dockerfile_sapsailing_on_sapmachine17' || 'docker/Dockerfile' }} context: docker/ + platforms: linux/amd64,linux/arm64 push: true - name: Clean up copied files shell: bash diff --git a/.github/workflows/merge-main-into-docker-17.yml b/.github/workflows/merge-main-into-docker-17.yml new file mode 100644 index 00000000000..4c69da3bf00 --- /dev/null +++ b/.github/workflows/merge-main-into-docker-17.yml @@ -0,0 +1,27 @@ +name: Merge main branch into docker-17 after successful build +on: + workflow_run: + workflows: [release] + types: [completed] + branches: [main] + workflow_dispatch: {} +jobs: + merge-main-into-docker-17: + if: ${{ github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success' }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + ref: docker-17 + fetch-depth: 0 # fetch the whole thing to make sure the histories merge + - name: Merge main into docker-17 + uses: devmasx/merge-branch@master + env: + GH_TOKEN: ${{ secrets.REPO_TOKEN_FOR_MERGE_AND_PUSH }} + with: + type: now + from_branch: main + target_branch: docker-17 + message: Auto-merging main into docker-17 after successful release build + github_token: ${{ secrets.REPO_TOKEN_FOR_MERGE_AND_PUSH }} diff --git a/.github/workflows/merge-sapsailing-com-master.yml b/.github/workflows/merge-sapsailing-com-master.yml new file mode 100644 index 00000000000..3cd5c2b4517 --- /dev/null +++ b/.github/workflows/merge-sapsailing-com-master.yml @@ -0,0 +1,31 @@ +# One of the reasons to have this workflow is that the Gollum-based Wiki +# at wiki.sapsailing.com is operating on a Git workspace at wiki@sapsailing.com:gitwiki +# which has been cloned from ssh://trac@sapsailing.com/home/trac/git. Its changes +# shall be synchronized to the Github repo at github.com/SAP/sailing-analytics +name: Merge master from sapsailing.com +on: + schedule: + - cron: "53 * * * *" # every hour, at :53 minutes + workflow_dispatch: {} +jobs: + merge-master-from-sapsailing-com: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + fetch-depth: 0 # fetch the whole thing to make sure the histories merge + - name: Create SSH key and fetch repo from sapsailing.com + shell: bash + run: | + mkdir -p ~/.ssh + chmod 700 ~/.ssh + echo "${{ secrets.SSH_PRIVATE_KEY_FOR_TRAC_SAPSAILING_COM }}" >~/.ssh/id_ed25519 + chmod 600 ~/.ssh/id_ed25519 + git remote add sapsailing ssh://trac@sapsailing.com/home/trac/git + git remote -v + GIT_SSH_COMMAND="ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no" git fetch sapsailing + git config --global user.email "github@sapsailing.com" + git config --global user.name "Github Auto-Merger" + git merge sapsailing/master + git push diff --git a/.pipeline/README b/.pipeline/README new file mode 100644 index 00000000000..9baf656193e --- /dev/null +++ b/.pipeline/README @@ -0,0 +1,7 @@ +This folder contains an Azure pipeline definition that is used for building our +Android companion apps, in particular the Sailing Race Manager app and the +Buoy Pinger app. See also the mobile/ folder for their source code. The +gradle build that is used at the core of this build pipeline is controlled +by the ``build.gradle``and ``gradle.properties`` file in the root folder. +A local Android app build can be achieved by running the ``gradlew`` +wrapper script from the root folder. diff --git a/.reuse/README b/.reuse/README new file mode 100644 index 00000000000..0d5afba287d --- /dev/null +++ b/.reuse/README @@ -0,0 +1,3 @@ +This folder is used by the workflow defined in ``.github/workflows/reuse-tool-license-updates.yml`` +and produces machine-readable licensing information for the entire repository into the dep5 file +in this same folder. diff --git a/Gemfile.lock b/Gemfile.lock index 17d9585c19d..67a87ee1234 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,9 @@ GEM remote: https://rubygems.org/ specs: - CFPropertyList (3.0.6) + CFPropertyList (3.0.7) + base64 + nkf rexml addressable (2.8.5) public_suffix (>= 2.0.2, < 6.0) @@ -24,6 +26,7 @@ GEM aws-sigv4 (1.6.0) aws-eventstream (~> 1, >= 1.0.2) babosa (1.0.4) + base64 (0.2.0) claide (1.1.0) colored (1.2) colored2 (3.1.2) @@ -161,6 +164,7 @@ GEM multipart-post (2.3.0) nanaimo (0.3.0) naturally (2.2.1) + nkf (0.2.0) optparse (0.1.1) os (1.1.4) plist (3.7.0) @@ -171,7 +175,8 @@ GEM trailblazer-option (>= 0.1.1, < 0.2.0) uber (< 0.2.0) retriable (3.1.2) - rexml (3.2.7) + rexml (3.2.8) + strscan (>= 3.0.9) rouge (2.0.7) ruby2_keywords (0.0.5) rubyzip (2.3.2) @@ -184,6 +189,7 @@ GEM simctl (1.6.10) CFPropertyList naturally + strscan (3.1.0) terminal-notifier (2.0.0) terminal-table (3.0.2) unicode-display_width (>= 1.1.1, < 3) @@ -199,7 +205,7 @@ GEM unicode-display_width (2.5.0) webrick (1.8.1) word_wrap (1.0.0) - xcodeproj (1.23.0) + xcodeproj (1.24.0) CFPropertyList (>= 2.3.3, < 4.0) atomos (~> 0.1.3) claide (>= 1.0.2, < 2.0) diff --git a/Home.md b/Home.md index 0dc4836e2a8..3d2498e3971 100644 --- a/Home.md +++ b/Home.md @@ -6,7 +6,7 @@ This is the Wik Like businesses, sailors need the latest information to make strategic decisions - but they need it even faster. One wrong tack, a false estimation of the current, or the slightest wind shift can cost the skipper the entire race. As premium sponsor of the Kieler Woche 2011, and co-sponsor of Sailing Team Germany (STG), SAP is showing how innovative IT solutions providing real time data analysis can give teams the competitive edge. -SAP is at the center of today’s technology revolution, developing innovations that not only help businesses run like never before, but also improve the lives of people everywhere. As market leader in enterprise application software, SAP SE (NYSE: SAP) helps companies of all sizes and industries run better. From back office to boardroom, warehouse to storefront, desktop to mobile device – SAP empowers people and organizations to work together more efficiently and use business insight more effectively to stay ahead of the competition. SAP applications and services enable more than 258,000 customers to operate profitably, adapt continuously, and grow sustainably. +SAP is at the center of today’s technology revolution, developing innovations that not only help businesses run like never before, but also improve the lives of people everywhere. As market leader in enterprise application software, SAP SE (NYSE: SAP) helps companies of all sizes and industries run better. From back office to boardroom, warehouse to storefront, desktop to mobile device – SAP empowers people and organizations to work together more efficiently and use business insight more effectively to stay ahead of the competition. SAP applications and services enable more than 400,000 customers to operate profitably, adapt continuously, and grow sustainably. # Table of Contents diff --git a/README.md b/README.md index 6bdade97156..a8a9ef5d0fa 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## About this Project -The Sailing Analytics, formerly known as the "SAP Sailing Analytics," are a solution for portraying and analyzing sailing regattas, supporting training scenarios, and powering the vast archive at https://sapsailing.com. +The Sailing Analytics, formerly known as the "SAP Sailing Analytics," are a solution for portraying and analyzing sailing regattas, supporting training scenarios, and powering the vast archive at https://sapsailing.com. The solution consists of a cloud application with a web-based user interface, as well as three companion apps that integrate with the cloud application. This repository has the code for the cloud-based web application, and two of the three mobile apps (Buoy Pinger and Race Manager). The third companion app (Sail Insight) is found in [another repository](https://github.com/SailTracks/sailinsight). ## Description @@ -16,9 +16,30 @@ Sailing provides the perfect platform for SAP to showcase solutions and help the SAP has a longstanding involvement with sailing and has established a portfolio spanning across teams and regattas. +## Quick Start with Docker Compose + +If you have built or obtained the ``ghcr.io/sap/sailing-analytics:latest`` multi-platform image (currently available for linux/amd64 and linux/arm64 architectures), try this: +``` + cd docker + docker-compose up +``` +Based on the ``docker/docker-compose.yml`` definition you should end up with three running Docker containers: +- a MongoDB server, listening on default port 27017 +- a RabbitMQ server, listening on default port +- a Sailing Analytics server, listening for HTTP requests on port 8888 and for telnet connections to the OSGi console on port 14888 + +Try a request to [``http://127.0.0.1:8888/index.html``](http://127.0.0.1:8888/index.html) or [``http://127.0.0.1:8888/gwt/status``](http://127.0.0.1:8888/gwt/status) to see if things worked. + +To use Java 17, use the ``docker-compose-17.yml`` file instead: + +``` + cd docker + docker-compose -f docker-compose-17.yml up +``` + ## Requirements -The software can be run on any Linux or Windows machine with ``bash`` installed; it has also been compiled successfully for the ARM platform and was deployed to a Raspberry Pi computer. As a database, MongoDB is required, tested with releases 4.4, 5.0, and 6.0. For use in a replicated scenario (scale-out, high availability), RabbitMQ is required. Docker Compose can be used to tie these three components together, as Docker images are produced on a regular basis. +The software can be run on any Linux or Windows machine with ``bash`` installed; it has also been compiled successfully for the ARM platform and was deployed to a Raspberry Pi computer. As a database, MongoDB is required, tested with releases 4.4, 5.0, and 6.0. For use in a replicated scenario (scale-out, high availability), RabbitMQ is required. A simple Docker Compose set-up can be used to tie these three components together, e.g., for a quick local test and to familiarize yourself with the application, as Docker images are produced on a regular basis. Compute node and database sizing depends on several aspects of your workloads, such as whether live or replay data is to be served, how many different classes with separate leaderboard are racing concurrently, how many competitors are racing in each class, or how many concurrent viewers produce how many requests and which type (e.g., analytical, data mining, or watching a live race). @@ -28,11 +49,13 @@ To quantify this at least approximately, here are a few examples for typical nod - Large multi-class event with 15 classes with their separate leaderboards, concurrently racing on six course areas: 16GB of RAM, 16 CPUs - Archive of 30,000 races with a few thousand visitors per day with varying analytical and replay workloads: 64GB RAM, 2TB NVMe swap, 8 CPUs -A single node typically handles up to 500 concurrent viewers for live events. You will want to scale out accordingly, using the replication pattern offered by the solution which uses RabbitMQ for transaction log shipping. +A single node typically handles up to 500-1000 concurrent viewers for live events. You will want to scale out accordingly, using the replication pattern offered by the solution which uses RabbitMQ for transaction log shipping. ## Contributing -To start contributing, read the onboarding document at the following URL: [https://wiki.sapsailing.com/wiki/howto/onboarding](https://wiki.sapsailing.com/wiki/howto/onboarding). The project welcomes contributions in the form of pull requests, for example, enhancements of the Data Mining functionality, including any sailing-specific metric or dimension you may think of and that you find is still missing so far; or additional features for the race viewer; or a map visualization that does not require a Google Map but uses Open Street Map / Open Layers; landscape automation; improved start sequence analytics; major UI improvements for the administrative layer ("AdminConsole"), etc. +To start contributing, read the onboarding document at the following URL: [https://wiki.sapsailing.com/wiki/howto/onboarding](https://wiki.sapsailing.com/wiki/howto/onboarding). Further documentation can be found in our Wiki at [https://wiki.sapsailing.com](https://wiki.sapsailing.com), serving the content from this repo's ``wiki/`` folder. + +The project welcomes contributions in the form of pull requests, for example, enhancements of the Data Mining functionality, including any sailing-specific metric or dimension you may think of and that you find is still missing so far; or additional features for the race viewer; or a map visualization that does not require a Google Map but uses Open Street Map / Open Layers; landscape automation; improved start sequence analytics; major UI improvements for the administrative layer ("AdminConsole"), etc. The issue tracker at [https://bugzilla.sapsailing.com](https://bugzilla.sapsailing.com) is currently used for any sort of issue and enhancement request tracking. Help to migrate this smoothly to Github Issues would be much appreciated, ideally keeping issue numbers stable due to many references to those Bugzilla bug numbers, be it in the source code, the Wiki, or the build infrastructure. @@ -49,16 +72,29 @@ See [here](https://www.sapsailing.com/gwt/Home.html#/imprint/:) for a list of co ## Building and Running -To build, invoke +This assumes you have completed the onboarding (see again [here](https://wiki.sapsailing.com/wiki/howto/onboarding)) successfully. To build, then invoke + ``` configuration/buildAndUpdateProduct.sh build ``` -If the build was successful you can install the product locally by invoking +This will build the Android companion apps first, then the web application. If the build was successful you can install the product locally by invoking + ``` configuration/buildAndUpdateProduct.sh install [ -s ] ``` + The default server name is taken to be your current branch name, e.g., ``master``. The install goes to ``${HOME}/servers/{server-name}``. You will find a ``start`` script there which you can use to launch the product. +Or you create a release by running + +``` + configuration/buildAndUpdateProduct.sh -L -u -n release +``` +which produces a tarball under ``dist/{release-name}-{timestamp}/{release-name}-{timestamp}.tar.gz`` which can then be used for ``scp``-based downloads with the ``refreshInstance.sh`` script under ``java/target``. + +Run the ``buildAndUpdateProduct.sh`` without any arguments to see the sub-commands and options available. + + ## Downloading, Installing and Running an Official Release You need to have Java 8 installed. Get one from [here](https://tools.eu1.hana.ondemand.com/#cloud). Either ensure that this JVM's ``java`` executable in on the ``PATH`` or set ``JAVA_HOME`` appropriately. @@ -124,27 +160,6 @@ Then patch or copy ``docker/Dockerfile`` so that it has (of course with the version tag adjusted to what you used above when you built/tagged the image). This will give you an SAP JVM 8 under ``/opt/sapjvm_8`` in the container which in particular includes the useful ``jvmmon`` utility specific to the SAP JVM 8. -## Docker Compose - -If you have built or obtained the ``ghcr.io/sap/sailing-analytics:latest`` image, try this: -``` - cd docker - docker-compose up -``` -Based on the ``docker/docker-compose.yml`` definition you should end up with three running Docker containers: -- a MongoDB server, listening on default port 27017 -- a RabbitMQ server, listening on default port -- a Sailing Analytics server, listening for HTTP requests on port 8888 and for telnet connections to the OSGi console on port 14888 - -Try a request to [``http://127.0.0.1:8888/index.html``](http://127.0.0.1:8888/index.html) or [``http://127.0.0.1:8888/gwt/status``](http://127.0.0.1:8888/gwt/status) to see if things worked. - -To use Java 17, use the ``docker-compose-17.yml`` file instead: - -``` - cd docker - docker-compose -f docker-compose-17.yml up -``` - ## Configuration Options, Environment Variables The server process can be configured in various ways. The corresponding environment variables you may use during installation with ``refreshInstance.sh`` and for setting up your Docker environment can be found in the following files: diff --git a/configuration/environments/security-service-master b/configuration/environments/security-service-master index 74bbc94438e..19588f4f4d2 100755 --- a/configuration/environments/security-service-master +++ b/configuration/environments/security-service-master @@ -1,5 +1,19 @@ +TELNET_PORT=14888 +SERVER_PORT=8888 +MONGODB_HOST=dbserver.internal.sapsailing.com +MONGODB_PORT=10202 +EXPEDITION_PORT=2010 +DEPLOY_TO=security_service +REPLICATE_MASTER_SERVLET_PORT=8888 +REPLICATE_MASTER_QUEUE_HOST=rabbit.internal.sapsailing.com +REPLICATE_MASTER_QUEUE_PORT=5672 +REPLICATION_HOST=rabbit.internal.sapsailing.com +ADDITIONAL_JAVA_ARGS="$ADDITIONAL_JAVA_ARGS -Dorg.eclipse.jetty.LEVEL=OFF -Dorg.eclipse.jetty.util.log.class=org.eclipse.jetty.util.log.StdErrLog -Drestore.tracked.races=true -Dpolardata.source.url=https://www.sapsailing.com -XX:ThreadPriorityPolicy=2" +SERVER_STARTUP_NOTIFY=axel.uhl@sap.com +BUILD_COMPLETE_NOTIFY=axel.uhl@sap.com + # To enable the use of the shared SecurityService and SharedSailingData from security-service.sapsailing.com: -ADDITIONAL_JAVA_ARGS="$ADDITIONAL_JAVA_ARGS -Dsecurity.sharedAcrossSubdomainsOf=sapsailing.com -Dsecurity.baseUrlForCrossDomainStorage=https://security-service.sapsailing.com -Dgwt.acceptableCrossDomainStorageRequestOriginRegexp=https?://(.*\.)?sapsailing\.com(:[0-9]*)?$" +ADDITIONAL_JAVA_ARGS="$ADDITIONAL_JAVA_ARGS -Dsecurity.sharedAcrossSubdomainsOf=sapsailing.com -Dsecurity.baseUrlForCrossDomainStorage=https://security-service.sapsailing.com -Dgwt.acceptableCrossDomainStorageRequestOriginRegexp=https?://((.*\.)?sapsailing\.com)|((.*\.)?sailing\.omegatiming\.com)(:[0-9]*)?$" # For the security-service master instance, don't activate replication from security-service #REPLICATE_ON_START=com.sap.sse.security.impl.SecurityServiceImpl,com.sap.sailing.shared.server.impl.SharedSailingDataImpl,com.sap.sse.landscape.aws.impl.AwsLandscapeStateImpl #REPLICATE_MASTER_SERVLET_HOST=security-service.sapsailing.com diff --git a/configuration/environments_scripts/build-crontab-and-cp-files b/configuration/environments_scripts/build-crontab-and-cp-files index 29cd6d5d8eb..34767c1dc81 100755 --- a/configuration/environments_scripts/build-crontab-and-cp-files +++ b/configuration/environments_scripts/build-crontab-and-cp-files @@ -3,18 +3,19 @@ # Purpose: The first parameter is an image type. This script iterates over the image types' USER folders, # concatenating all the symbolic links (referencing locations within configuration/crontabs) into one crontab # file for each user. It also takes the name of the user containing a copy of the git repo as well as the name of the -# dir within that user to go to. The created files for each user go into that user's home dir and are installed for -# that user too. +# dir within that user to go to. The created crontab for each user go into that user's home dir and are installed for +# that user too. # Within these crontab stubs, are certain string literals, which are replaced: PATH_OF_GIT_HOME_DIR_TO_REPLACE becomes # the absolute path to the git home dir, and PATH_OF_HOME_DIR_TO_REPLACE is changed to the path of the home directory -# in which the crontab will be installed. -# Furthermore, within the users folder optional uid, gid and groups files an exist. uid should store the user's uid, -# gid the group id and groups should have secondary groups (one per line). The secondary groups are added after all users are -# created. +# in which the crontab will be installed (ie. that user's home). +# Furthermore, within the users folder optional uid, gid and groups files can exist. uid should store the user's uid, +# gid the group id and groups should have secondary groups (one per line). The user is added to the secondary groups +# after all users are created. # Useful files are also copied across from the "files" dir within each image type. # Finally, the script ends by performing a deamon reload and reenabling all the systemd units in the files directory, # so that the correct wants, requires, etc. are installed/linked. Any systemd units, within the mimicked filesystem, -# will be automatically enabled. +# will be automatically enabled. +# For options, see the help below. # This script should NOT be installed into /usr/local/bin. See the README for more. INSTALL_CRONTAB="true" @@ -27,11 +28,11 @@ do c) CREATE_CRONTABS="false";; f) COPY_FILES="false";; n) INSTALL_CRONTAB="false";; - \?) echo "Invalid option" + \?) echo "Invalid option" # getops replaces unknown options with a question mark, so we have to escape the question mark. exit 4;; esac done -shift $((OPTIND-1)) # shift the arguments along so -s is no longer $1 +shift $((OPTIND-1)) # shift the arguments along so there are no options in the arguments anymore. if [[ "$#" -ne 3 ]]; then echo "$0 " echo "" @@ -60,9 +61,10 @@ if [[ -d "groups" ]]; then fi if [[ -d "users" ]]; then cd "users" - GIT_PATH="$(eval echo $(printf "~%q" "$GIT_USER"))/${RELATIVE_GIT_DIR_NAME}" # The path to the git repo that contains the files needed. - for dir in $(ls -d */ ); do - USERNAME=$(echo "$dir" | sed "s/\/$//") # Dirname is the username. The trailing slash is removed. + GIT_PATH="$(eval echo $(printf "~%q" "$GIT_USER"))/${RELATIVE_GIT_DIR_NAME}" # The absolute path to a git repo in the environment type. + for dir in *; do + [[ -d "$dir" ]] || continue + USERNAME="$dir" user_UID="" user_GID="" echo "STARTING WORK ON USER $USERNAME" @@ -112,8 +114,9 @@ if [[ -d "users" ]]; then echo "****** finished user ******" done # Add to groups after all the groups exist. - for dir in $(ls -d */ ); do - USERNAME=$(echo "$dir" | sed "s/\/$//") # Dirname is the username. The trailing slash is removed. + for dir in *; do + [[ -d "$dir" ]] || continue + USERNAME="$dir" [[ -e "$USERNAME"/groups ]] || continue echo "ADDING $USERNAME TO THE GROUPS SPECIFIED IN THEIR 'groups' FILE" for group in $(cat "$USERNAME"/groups); do diff --git a/configuration/environments_scripts/central_reverse_proxy/files/etc/awstats/awstats.model.conf.sample b/configuration/environments_scripts/central_reverse_proxy/files/etc/awstats/awstats.model.conf.sample new file mode 100644 index 00000000000..952a13de8c8 --- /dev/null +++ b/configuration/environments_scripts/central_reverse_proxy/files/etc/awstats/awstats.model.conf.sample @@ -0,0 +1,1550 @@ +# AWSTATS CONFIGURE FILE 7.0 +#----------------------------------------------------------------------------- +# Copy this file into awstats.www.mydomain.conf and edit this new config file +# to setup AWStats (See documentation in docs/ directory). +# The config file must be in /etc/awstats, /usr/local/etc/awstats or /etc (for +# Unix/Linux) or same directory than awstats.pl (Windows, Mac, Unix/Linux...) +# To include an environment variable in any parameter (AWStats will replace +# it with its value when reading it), follow the example: +# Parameter="__ENVNAME__" +# Note that environment variable AWSTATS_CURRENT_CONFIG is always defined with +# the config value in an AWStats running session and can be used like others. +#----------------------------------------------------------------------------- +# $Revision: 1.350 $ - $Author: eldy $ - $Date: 2010/09/29 19:16:21 $ + + + +#----------------------------------------------------------------------------- +# MAIN SETUP SECTION (Required to make AWStats work) +#----------------------------------------------------------------------------- + +# "LogFile" contains the web, ftp or mail server log file to analyze. +# Possible values: A full path, or a relative path from awstats.pl directory. +# Example: "/var/log/apache/access.log" +# Example: "../logs/mycombinedlog.log" +# You can also use tags in this filename if you need a dynamic file name +# depending on date or time (Replacement is made by AWStats at the beginning +# of its execution). This is available tags : +# %YYYY-n is replaced with 4 digits year we were n hours ago +# %YY-n is replaced with 2 digits year we were n hours ago +# %MM-n is replaced with 2 digits month we were n hours ago +# %MO-n is replaced with 3 letters month we were n hours ago +# %DD-n is replaced with day we were n hours ago +# %HH-n is replaced with hour we were n hours ago +# %NS-n is replaced with number of seconds at 00:00 since 1970 +# %WM-n is replaced with the week number in month (1-5) +# %Wm-n is replaced with the week number in month (0-4) +# %WY-n is replaced with the week number in year (01-52) +# %Wy-n is replaced with the week number in year (00-51) +# %DW-n is replaced with the day number in week (1-7, 1=sunday) +# use n=24 if you need (1-7, 1=monday) +# %Dw-n is replaced with the day number in week (0-6, 0=sunday) +# use n=24 if you need (0-6, 0=monday) +# Use 0 for n if you need current year, month, day, hour... +# Example: "/var/log/access_log.%YYYY-0%MM-0%DD-0.log" +# Example: "C:/WINNT/system32/LogFiles/W3SVC1/ex%YY-24%MM-24%DD-24.log" +# You can also use a pipe if log file come from a pipe : +# Example: "gzip -d outputpath/output.html"), enter +# path of icon directory relative to the output directory 'outputpath'. +# Example: "/awstatsicons" +# Example: "../icon" +# Default: "/icon" (means you must copy icon directories in "/mywwwroot/icon") +# +DirIcons="/awstatsicons" + + +# When this parameter is set to 1, AWStats adds a button on report page to +# allow to "update" statistics from a web browser. Warning, when "update" is +# made from a browser, AWStats is run as a CGI by the web server user defined +# in your web server (user "nobody" by default with Apache, "IUSR_XXX" with +# IIS), so the "DirData" directory and all already existing history files +# awstatsMMYYYY[.xxx].txt must be writable by this user. Change permissions if +# necessary to "Read/Write" (and "Modify" for Windows NTFS file systems). +# Warning: Update process can be long so you might experience "time out" +# browser errors if you don't launch AWStats frequently enough. +# When set to 0, update is only made when AWStats is run from the command +# line interface (or a task scheduler). +# Possible values: 0 or 1 +# Default: 0 +# +AllowToUpdateStatsFromBrowser=0 + + +# AWStats saves and sorts its database on a month basis (except if using +# databasebreak option from command line). +# However, if you choose the -month=all from command line or +# value '-Year-' from CGI combo form to have a report for all year, AWStats +# needs to reload all data for full year (each month), and sort them, +# requiring a large amount of time, memory and CPU. This might be a problem +# for web hosting providers that offer AWStats for large sites, on shared +# servers, to non CPU cautious customers. +# For this reason, the 'full year' is only enabled on Command Line by default. +# You can change this by setting this parameter to 0, 1, 2 or 3. +# Possible values: +# 0 - Never allowed +# 1 - Allowed on CLI only, -Year- value in combo is not visible +# 2 - Allowed on CLI only, -Year- value in combo is visible but not allowed +# 3 - Possible on CLI and CGI +# Default: 2 +# +AllowFullYearView=2 + + + +#----------------------------------------------------------------------------- +# OPTIONAL SETUP SECTION (Not required but increase AWStats features) +#----------------------------------------------------------------------------- + +# When the update process runs, AWStats can set a lock file in TEMP or TMP +# directory. This lock is to avoid to have 2 update processes running at the +# same time to prevent unknown conflicts problems and avoid DoS attacks when +# AllowToUpdateStatsFromBrowser is set to 1. +# Because, when you use lock file, you can experience sometimes problems in +# lock file not correctly removed (killed process for example requires that +# you remove the file manualy), this option is not enabled by default (Do +# not enable this option with no console server access). +# Change : Effective immediatly +# Possible values: 0 or 1 +# Default: 0 +# +EnableLockForUpdate=1 + + +# AWStats can do reverse DNS lookups through a static DNS cache file that was +# previously created manually. If no path is given in static DNS cache file +# name, AWStats will search DirData directory. This file is never changed. +# This option is not used if DNSLookup=0. +# Note: DNS cache file format is 'minsince1970 ipaddress resolved_hostname' +# or just 'ipaddress resolved_hostname' +# Change : Effective for new updates only +# Example: "/mydnscachedir/dnscache" +# Default: "dnscache.txt" +# +DNSStaticCacheFile="dnscache.txt" + + +# AWStats can do reverse DNS lookups through a DNS cache file that was created +# by a previous run of AWStats. This file is erased and recreated after each +# statistics update process. You don't need to create and/or edit it. +# AWStats will read and save this file in DirData directory. +# This option is used only if DNSLookup=1. +# Note: If a DNSStaticCacheFile is available, AWStats will check for DNS +# lookup in DNSLastUpdateCacheFile after checking into DNSStaticCacheFile. +# Change : Effective for new updates only +# Example: "/mydnscachedir/dnscachelastupdate" +# Default: "dnscachelastupdate.txt" +# +DNSLastUpdateCacheFile="dnscachelastupdate.txt" + + +# You can specify specific IP addresses that should NOT be looked up in DNS. +# This option is used only if DNSLookup=1. +# Note: Use space between each value. +# Note: You can use regular expression values writing value with REGEX[value]. +# Change : Effective for new updates only +# Example: "123.123.123.123 REGEX[^192\.168\.]" +# Default: "" +# +SkipDNSLookupFor="" + + +# The following two parameters allow you to protect a config file from being +# read by AWStats when called from a browser if web user has not been +# authenticated. Your AWStats program must be in a web protected "realm" (With +# Apache, you can use .htaccess files to do so. With other web servers, see +# your server setup manual). +# Change : Effective immediatly +# Possible values: 0 or 1 +# Default: 0 +# +AllowAccessFromWebToAuthenticatedUsersOnly=0 + + +# This parameter gives the list of all authorized authenticated users to view +# statistics for this domain/config file. This parameter is used only if +# AllowAccessFromWebToAuthenticatedUsersOnly is set to 1. +# Change : Effective immediatly +# Example: "user1 user2" +# Example: "__REMOTE_USER__" +# Default: "" +# +AllowAccessFromWebToFollowingAuthenticatedUsers="" + + +# When this parameter is defined to something, the IP address of the user that +# reads its statistics from a browser (when AWStats is used as a CGI) is +# checked and must match one of the IP address values or ranges. +# Change : Effective immediatly +# Example: "127.0.0.1 123.123.123.1-123.123.123.255" +# Default: "" +# +AllowAccessFromWebToFollowingIPAddresses="" + + +# If the "DirData" directory (see above) does not exist, AWStats return an +# error. However, you can ask AWStats to create it. +# This option can be used by some Web Hosting Providers that has defined a +# dynamic value for DirData (for example DirData="/home/__REMOTE_USER__") and +# don't want to have to create a new directory each time they add a new user. +# Change : Effective immediatly +# Possible values: 0 or 1 +# Default: 0 +# +CreateDirDataIfNotExists=0 + + +# You can choose in which format the Awstats history database is saved. +# Note: Using "xml" format make AWStats building database files three times +# larger than using "text" format. +# Change : Database format is switched after next update +# Possible values: text or xml +# Default: text +# +BuildHistoryFormat=text + + +# If you prefer having the report output pages be built as XML compliant pages +# instead of simple HTML pages, you can set this to 'xhtml' (May not work +# properly with old browsers). +# Change : Effective immediatly +# Possible values: html or xhtml +# Default: html +# +BuildReportFormat=html + + +# AWStats databases can be updated from command line of from a browser (when +# used as a cgi program). So AWStats database files need write permission +# for both command line user and default web server user (nobody for Unix, +# IUSR_xxx for IIS/Windows,...). +# To avoid permission problems between update process (run by an admin user) +# and CGI process (ran by a low level user), AWStats can save its database +# files with read and write permissions for everyone. +# By default, AWStats keeps default user permissions on updated files. If you +# set AllowToUpdateStatsFromBrowser to 1, you can change this parameter to 1. +# Change : Effective for new updates only +# Possible values: 0 or 1 +# Default: 0 +# +SaveDatabaseFilesWithPermissionsForEveryone=0 + + +# AWStats can purge log file, after analyzing it. Note that AWStats is able +# to detect new lines in a log file, to process only them, so you can launch +# AWStats as often as you want, even with this parameter to 0. +# With 0, no purge is made, so you must use a scheduled task or a web server +# that make this purge frequently. +# With 1, the purge of the log file is made each time AWStats update is run. +# This parameter doesn't work with IIS (This web server doesn't let its log +# file to be purged). +# Change : Effective for new updates only +# Possible values: 0 or 1 +# Default: 0 +# +PurgeLogFile=0 + + +# When PurgeLogFile is setup to 1, AWStats will clean your log file after +# processing it. You can however keep an archive file of all processed log +# records by setting this parameter (For example if you want to use another +# log analyzer). The archived log file is saved in "DirData" with name +# awstats_archive.configname[.suffix].log +# This parameter is not used if PurgeLogFile=0 +# Change : Effective for new updates only +# Possible values: 0, 1, or tags (See LogFile parameter) for suffix +# Example: 1 +# Example: %YYYY%MM%DD +# Default: 0 +# +ArchiveLogRecords=0 + + +# Each time you run the update process, AWStats overwrites the 'historic file' +# for the month (awstatsMMYYYY[.*].txt) with the updated one. +# When write errors occurs (IO, disk full,...), this historic file can be +# corrupted and must be deleted. Because this file contains information of all +# past processed log files, you will loose old stats if removed. So you can +# ask AWStats to save last non corrupted file in a .bak file. This file is +# stored in "DirData" directory with other 'historic files'. +# Change : Effective for new updates only +# Possible values: 0 or 1 +# Default: 0 +# +KeepBackupOfHistoricFiles=0 + + +# Default index page name for your web server. +# Change : Effective for new updates only +# Example: "index.php index.html default.html" +# Default: "index.php index.html" +# +DefaultFile="index.php index.html" + + +# Do not include access from clients that match following criteria. +# If your log file contains IP addresses in host field, you must enter here +# matching IP addresses criteria. +# If DNS lookup is already done in your log file, you must enter here hostname +# criteria, else enter ip address criteria. +# The opposite parameter of "SkipHosts" is "OnlyHosts". +# Note: Use space between each value. This parameter is not case sensitive. +# Note: You can use regular expression values writing value with REGEX[value]. +# Change : Effective for new updates only +# Example: "127.0.0.1 REGEX[^192\.168\.] REGEX[^10\.]" +# Example: "localhost REGEX[^.*\.localdomain$]" +# Default: "" +# +SkipHosts="127.0.0.1" + + +# Do not include access from clients with a user agent that match following +# criteria. If you want to exclude a robot, you should update the robots.pm +# file instead of this parameter. +# The opposite parameter of "SkipUserAgents" is "OnlyUserAgents". +# Note: Use space between each value. This parameter is not case sensitive. +# Note: You can use regular expression values writing value with REGEX[value]. +# Change : Effective for new updates only +# Example: "konqueror REGEX[ua_test_v\d\.\d]" +# Default: "" +# +SkipUserAgents="" + + +# Use SkipFiles to ignore access to URLs that match one of following entries. +# You can enter a list of not important URLs (like framed menus, hidden pages, +# etc...) to exclude them from statistics. You must enter here exact relative +# URL as found in log file, or a matching REGEX value. Check apply on URL with +# all its query paramaters. +# For example, to ignore /badpage.php, just add "/badpage.php". To ignore all +# pages in a particular directory, add "REGEX[^\/directorytoexclude]". +# The opposite parameter of "SkipFiles" is "OnlyFiles". +# Note: Use space between each value. This parameter is or not case sensitive +# depending on URLNotCaseSensitive parameter. +# Note: You can use regular expression values writing value with REGEX[value]. +# Change : Effective for new updates only +# Example: "/badpage.php /page.php?param=x REGEX[^\/excludedirectory]" +# Default: "" +# +SkipFiles="" + + +# Use SkipReferrersBlackList if you want to exclude records coming from a SPAM +# referrer. Parameter must receive a local file name containing rules applied +# on referrer field. If parameter is empty, no filter is applied. +# An example of such a file is available in lib/blacklist.txt +# Change : Effective for new updates only +# Example: "/mylibpath/blacklist.txt" +# Default: "" +# +# WARNING!! Using this feature make AWStats running very slower (5 times slower +# with black list file provided with AWStats ! +# +SkipReferrersBlackList="" + + +# Include in stats, only accesses from hosts that match one of following +# entries. For example, if you want AWStats to filter access to keep only +# stats for visits from particular hosts, you can add those host names in +# this parameter. +# If DNS lookup is already done in your log file, you must enter here hostname +# criteria, else enter ip address criteria. +# The opposite parameter of "OnlyHosts" is "SkipHosts". +# Note: Use space between each value. This parameter is not case sensitive. +# Note: You can use regular expression values writing value with REGEX[value]. +# Change : Effective for new updates only +# Example: "127.0.0.1 REGEX[^192\.168\.] REGEX[^10\.]" +# Default: "" +# +OnlyHosts="" + + +# Include in stats, only accesses from user agent that match one of following +# entries. For example, if you want AWStats to filter access to keep only +# stats for visits from particular browsers, you can add their user agents +# string in this parameter. +# The opposite parameter of "OnlyUserAgents" is "SkipUserAgents". +# Note: Use space between each value. This parameter is not case sensitive. +# Note: You can use regular expression values writing value with REGEX[value]. +# Change : Effective for new updates only +# Example: "msie" +# Default: "" +# +OnlyUserAgents="" + + +# Include in stats, only accesses from authenticated users that match one of +# following entries. For example, if you want AWStats to filter access to keep +# only stats for authenticated users, you can add those users names in +# this parameter. Useful for statistics for per user ftp logs. +# Note: Use space between each value. This parameter is not case sensitive. +# Note: You can use regular expression values writing value with REGEX[value]. +# Change : Effective for new updates only +# Example: "john bob REGEX[^testusers]" +# Default: "" +# +OnlyUsers="" + + +# Include in stats, only accesses to URLs that match one of following entries. +# For example, if you want AWStats to filter access to keep only stats that +# match a particular string, like a particular directory, you can add this +# directory name in this parameter. +# The opposite parameter of "OnlyFiles" is "SkipFiles". +# Note: Use space between each value. This parameter is or not case sensitive +# depending on URLNotCaseSensitive parameter. +# Note: You can use regular expression values writing value with REGEX[value]. +# Change : Effective for new updates only +# Example: "REGEX[marketing_directory] REGEX[office\/.*\.(csv|sxw)$]" +# Default: "" +# +OnlyFiles="" + + +# Add here a list of kind of url (file extension) that must be counted as +# "Hit only" and not as a "Hit" and "Page/Download". You can set here all +# image extensions as they are hit downloaded that must be counted but they +# are not viewed pages. URLs with such extensions are not included in the TOP +# Pages/URL report. +# Note: If you want to exclude particular URLs from stats (No Pages and no +# Hits reported), you must use SkipFiles parameter. +# Change : Effective for new updates only +# Example: "css js class gif jpg jpeg png bmp ico rss xml swf zip arj rar gz z bz2 wav mp3 wma mpg avi" +# Example: "" +# Default: "css js class gif jpg jpeg png bmp ico rss xml swf" +# +NotPageList="css js class gif jpg jpeg png bmp ico rss xml swf" + + +# By default, AWStats considers that records found in web log file are +# successful hits if HTTP code returned by server is a valid HTTP code (200 +# and 304). Any other code are reported in HTTP status chart. +# Note that HTTP 'control codes', like redirection (302, 305) are not added by +# default in this list as they are not pages seen by a visitor but are +# protocol exchange codes to tell the browser to ask another page. Because +# this other page will be counted and seen with a 200 or 304 code, if you +# add such codes, you will have 2 pages viewed reported for only one in facts. +# Change : Effective for new updates only +# Example: "200 304 302 305" +# Default: "200 304" +# +ValidHTTPCodes="200 304" + + +# By default, AWStats considers that records found in mail log file are +# successful mail transfers if field that represent return code in analyzed +# log file match values defined by this parameter. +# Change : Effective for new updates only +# Example: "1 250 200" +# Default: "1 250" +# +ValidSMTPCodes="1 250" + + +# Some web servers on some Operating systems (IIS-Windows) consider that a +# login with same value but different case are the same login. To tell AWStats +# to also consider them as one, set this parameter to 1. +# Change : Effective for new updates only +# Possible values: 0 or 1 +# Default: 0 +# +AuthenticatedUsersNotCaseSensitive=0 + + +# Some web servers on some Operating systems (IIS-Windows) considers that two +# URLs with same value but different case are the same URL. To tell AWStats to +# also considers them as one, set this parameter to 1. +# Change : Effective for new updates only +# Possible values: 0 or 1 +# Default: 0 +# +URLNotCaseSensitive=0 + + +# Keep or remove the anchor string you can find in some URLs. +# Change : Effective for new updates only +# Possible values: 0 or 1 +# Default: 0 +# +URLWithAnchor=0 + + +# In URL links, "?" char is used to add parameter's list in URLs. Syntax is: +# /mypage.html?param1=value1¶m2=value2 +# However, some servers/sites use also other chars to isolate dynamic part of +# their URLs. You can complete this list with all such characters. +# Change : Effective for new updates only +# Example: "?;," +# Default: "?;" +# +URLQuerySeparators="?;" + + +# Keep or remove the query string to the URL in the statistics for individual +# pages. This is primarily used to differentiate between the URLs of dynamic +# pages. If set to 1, mypage.html?id=x and mypage.html?id=y are counted as two +# different pages. +# Warning, when set to 1, memory required to run AWStats is dramatically +# increased if you have a lot of changing URLs (for example URLs with a random +# id inside). Such web sites should not set this option to 1 or use seriously +# the next parameter URLWithQueryWithOnlyFollowingParameters (or eventually +# URLWithQueryWithoutFollowingParameters). +# Change : Effective for new updates only +# Possible values: +# 0 - URLs are cleaned from the query string (ie: "/mypage.html") +# 1 - Full URL with query string is used (ie: "/mypage.html?p=x&q=y") +# Default: 0 +# +URLWithQuery=0 + + +# When URLWithQuery is on, you will get the full URL with all parameters in +# URL reports. But among thoose parameters, sometimes you don't need a +# particular parameter because it does not identify the page or because it's +# a random ID changing for each access even if URL points to same page. In +# such cases, it is higly recommanded to ask AWStats to keep only parameters +# you need (if you know them) before counting, manipulating and storing URL. +# Enter here list of wanted parameters. For example, with "param", one hit on +# /mypage.cgi?param=abc&id=Yo4UomP9d and /mypage.cgi?param=abc&id=Mu8fdxl3r +# will be reported as 2 hits on /mypage.cgi?param=abc +# This parameter is not used when URLWithQuery is 0 and can't be used with +# URLWithQueryWithoutFollowingParameters. +# Change : Effective for new updates only +# Example: "param" +# Default: "" +# +URLWithQueryWithOnlyFollowingParameters="" + + +# When URLWithQuery is on, you will get the full URL with all parameters in +# URL reports. But among thoose parameters, sometimes you don't need a +# particular parameter because it does not identify the page or because it's +# a random ID changing for each access even if URL points to same page. In +# such cases, it is higly recommanded to ask AWStats to remove such parameters +# from the URL before counting, manipulating and storing URL. Enter here list +# of all non wanted parameters. For example if you enter "id", one hit on +# /mypage.cgi?param=abc&id=Yo4UomP9d and /mypage.cgi?param=abc&id=Mu8fdxl3r +# will be reported as 2 hits on /mypage.cgi?param=abc +# This parameter is not used when URLWithQuery is 0 and can't be used with +# URLWithQueryWithOnlyFollowingParameters. +# Change : Effective for new updates only +# Example: "PHPSESSID jsessionid" +# Default: "" +# +URLWithQueryWithoutFollowingParameters="" + + +# Keep or remove the query string to the referrer URL in the statistics for +# external referrer pages. This is used to differentiate between the URLs of +# dynamic referrer pages. If set to 1, mypage.html?id=x and mypage.html?id=y +# are counted as two different referrer pages. +# Change : Effective for new updates only +# Possible values: +# 0 - Referrer URLs are cleaned from the query string (ie: "/mypage.html") +# 1 - Full URL with query string is used (ie: "/mypage.html?p=x&q=y") +# Default: 0 +# +URLReferrerWithQuery=0 + + +# AWStats can detect setup problems or show you important informations to have +# a better use. Keep this to 1, except if AWStats says you can change it. +# Change : Effective immediatly +# Possible values: 0 or 1 +# Default: 1 +# +WarningMessages=1 + + +# When an error occurs, AWStats outputs a message related to errors. If you +# want (in most cases for security reasons) to have no error messages, you +# can set this parameter to your personalized generic message. +# Change : Effective immediatly +# Example: "An error occurred. Contact your Administrator" +# Default: "" +# +ErrorMessages="" + + +# AWStat can be run with debug=x parameter to output various informations +# to help in debugging or solving troubles. If you want to allow this (not +# enabled by default for security reasons), set this parameter to 0. +# Change : Effective immediatly +# Possible values: 0 or 1 +# Default: 0 +# +DebugMessages=0 + + +# To help you to detect if your log format is good, AWStats reports an error +# if all the first NbOfLinesForCorruptedLog lines have a format that does not +# match the LogFormat parameter. +# However, some worm virus attack on your web server can result in a very high +# number of corrupted lines in your log. So if you experience awstats stop +# because of bad virus records at the beginning of your log file, you can +# increase this parameter (very rare). +# Change : Effective for new updates only +# Default: 50 +# +NbOfLinesForCorruptedLog=50 + + +# For some particular integration needs, you may want to have CGI links to +# point to another script than awstats.pl. +# Use the name of this script in WrapperScript parameter. +# Change : Effective immediatly +# Example: "awstatslauncher.pl" +# Example: "awstatswrapper.cgi?key=123" +# Default: "" +# +WrapperScript="" + + +# DecodeUA must be set to 1 if you use Roxen web server. This server converts +# all spaces in user agent field into %20. This make the AWStats robots, OS +# and browsers detection fail in some cases. Just change it to 1 if and only +# if your web server is Roxen. +# Change : Effective for new updates only +# Possible values: 0 or 1 +# Default: 0 +# +DecodeUA=0 + + +# MiscTrackerUrl can be used to make AWStats able to detect some miscellaneous +# things, that can not be tracked on other way, like: +# - Javascript disabled +# - Java enabled +# - Screen size +# - Color depth +# - Macromedia Director plugin +# - Macromedia Shockwave plugin +# - Realplayer G2 plugin +# - QuickTime plugin +# - Mediaplayer plugin +# - Acrobat PDF plugin +# To enable all these features, you must copy the awstats_misc_tracker.js file +# into a /js/ directory stored in your web document root and add the following +# HTML code at the end of your index page (but before ) : +# +# +# +# +# If code is not added in index page, all those detection capabilities will be +# disabled. You must also check that ShowScreenSizeStats and ShowMiscStats +# parameters are set to 1 to make results appear in AWStats report page. +# If you want to use another directory than /js/, you must also change the +# awstatsmisctrackerurl variable into the awstats_misc_tracker.js file. +# Change : Effective for new updates only. +# Possible value: URL of javascript tracker file added in your HTML code. +# Default: "/js/awstats_misc_tracker.js" +# +MiscTrackerUrl="/js/awstats_misc_tracker.js" + + + +#----------------------------------------------------------------------------- +# OPTIONAL ACCURACY SETUP SECTION (Not required but increase AWStats features) +#----------------------------------------------------------------------------- + +# The following values allow you to define accuracy of AWStats entities +# (robots, browsers, os, referers, file types) detection. +# It might be a good idea for large web sites or ISP that provides AWStats to +# high number of customers, to set this parameter to 1 (or 0), instead of 2. +# Possible values: +# 0 = No detection, +# 1 = Medium/Standard detection +# 2 = Full detection +# Change : Effective for new updates only +# Note : LevelForBrowsersDetection can also accept value "allphones". This +# enable detailed detection of phone/pda browsers. +# Default: 2 (0 for LevelForWormsDetection) +# +LevelForBrowsersDetection=2 # 0 disables Browsers detection. + # 2 reduces AWStats speed by 2% + # allphones reduces AWStats speed by 5% +LevelForOSDetection=2 # 0 disables OS detection. + # 2 reduces AWStats speed by 3% +LevelForRefererAnalyze=2 # 0 disables Origin detection. + # 2 reduces AWStats speed by 14% +LevelForRobotsDetection=2 # 0 disables Robots detection. + # 2 reduces AWStats speed by 2.5% +LevelForSearchEnginesDetection=2 # 0 disables Search engines detection. + # 2 reduces AWStats speed by 9% +LevelForKeywordsDetection=2 # 0 disables Keyphrases/Keywords detection. + # 2 reduces AWStats speed by 1% +LevelForFileTypesDetection=2 # 0 disables File types detection. + # 2 reduces AWStats speed by 1% +LevelForWormsDetection=0 # 0 disables Worms detection. + # 2 reduces AWStats speed by 15% + + + +#----------------------------------------------------------------------------- +# OPTIONAL APPEARANCE SETUP SECTION (Not required but increase AWStats features) +#----------------------------------------------------------------------------- + +# When you use AWStats as a CGI, you can have the reports shown in HTML frames. +# Frames are only available for report viewed dynamically. When you build +# pages from command line, this option is not used and no frames are built. +# Possible values: 0 or 1 +# Default: 1 +# +UseFramesWhenCGI=1 + + +# This parameter asks your browser to open detailed reports into a different +# window than the main page. +# Possible values: +# 0 - Open all in same browser window +# 1 - Open detailed reports in another window except if using frames +# 2 - Open always in a different window even if reports are framed +# Default: 1 +# +DetailedReportsOnNewWindows=1 + + +# You can add, in the HTML report page, a cache lifetime (in seconds) that +# will be returned to the browser in HTTP header answer by server. +# This parameter is not used when reports are built with -staticlinks option. +# Example: 3600 +# Default: 0 +# +Expires=3600 + + +# To avoid too large web pages, you can ask AWStats to limit number of rows of +# all reported charts to this number when no other limits apply. +# Default: 1000 +# +MaxRowsInHTMLOutput=1000 + + +# Set your primary language (ISO-639-1 language codes). +# Possible values: +# Albanian=al, Bosnian=ba, Bulgarian=bg, Catalan=ca, +# Chinese (Taiwan)=tw, Chinese (Simpliefied)=cn, Croatian=hr, Czech=cz, +# Danish=dk, Dutch=nl, English=en, Estonian=et, Euskara=eu, Finnish=fi, +# French=fr, Galician=gl, German=de, Greek=gr, Hebrew=he, Hungarian=hu, +# Icelandic=is, Indonesian=id, Italian=it, Japanese=jp, Korean=ko, +# Latvian=lv, Norwegian (Nynorsk)=nn, Norwegian (Bokmal)=nb, Polish=pl, +# Portuguese=pt, Portuguese (Brazilian)=br, Romanian=ro, Russian=ru, +# Serbian=sr, Slovak=sk, Slovenian=si, Spanish=es, Swedish=se, Turkish=tr, +# Ukrainian=ua, Welsh=cy. +# First available language accepted by browser=auto +# Default: "auto" +# +Lang="auto" + + +# Set the location of language files. +# Example: "/usr/share/awstats/lang" +# Default: "./lang" (means lang directory is in same location than awstats.pl) +# +DirLang="./lang" + + +# Show menu header with reports' links +# Possible values: 0 or 1 +# Default: 1 +# +ShowMenu=1 + + +# You choose here which reports you want to see in the main page and what you +# want to see in those reports. +# Possible values: +# 0 - Report is not shown at all +# 1 - Report is shown in main page with an entry in menu and default columns +# XYZ - Report shows column informations defined by code X,Y,Z... +# X,Y,Z... are code letters among the following: +# U = Unique visitors +# V = Visits +# P = Number of pages +# H = Number of hits (or mails) +# B = Bandwith (or total mail size for mail logs) +# L = Last access date +# E = Entry pages +# X = Exit pages +# C = Web compression (mod_gzip,mod_deflate) +# M = Average mail size (mail logs) +# + +# Show monthly summary +# Context: Web, Streaming, Mail, Ftp +# Default: UVPHB, Possible column codes: UVPHB +ShowSummary=UVPHB + +# Show monthly chart +# Context: Web, Streaming, Mail, Ftp +# Default: UVPHB, Possible column codes: UVPHB +ShowMonthStats=UVPHB + +# Show days of month chart +# Context: Web, Streaming, Mail, Ftp +# Default: VPHB, Possible column codes: VPHB +ShowDaysOfMonthStats=VPHB + +# Show days of week chart +# Context: Web, Streaming, Mail, Ftp +# Default: PHB, Possible column codes: PHB +ShowDaysOfWeekStats=PHB + +# Show hourly chart +# Context: Web, Streaming, Mail, Ftp +# Default: PHB, Possible column codes: PHB +ShowHoursStats=PHB + +# Show domains/country chart +# Context: Web, Streaming, Mail, Ftp +# Default: PHB, Possible column codes: PHB +ShowDomainsStats=PHB + +# Show hosts chart +# Context: Web, Streaming, Mail, Ftp +# Default: PHBL, Possible column codes: PHBL +ShowHostsStats=PHBL + +# Show authenticated users chart +# Context: Web, Streaming, Ftp +# Default: 0, Possible column codes: PHBL +ShowAuthenticatedUsers=0 + +# Show robots chart +# Context: Web, Streaming +# Default: HBL, Possible column codes: HBL +ShowRobotsStats=HBL + +# Show worms chart +# Context: Web, Streaming +# Default: 0 (If set to other than 0, see also LevelForWormsDetection), Possible column codes: HBL +ShowWormsStats=0 + +# Show email senders chart (For use when analyzing mail log files) +# Context: Mail +# Default: 0, Possible column codes: HBML +ShowEMailSenders=0 + +# Show email receivers chart (For use when analyzing mail log files) +# Context: Mail +# Default: 0, Possible column codes: HBML +ShowEMailReceivers=0 + +# Show session chart +# Context: Web, Streaming, Ftp +# Default: 1, Possible column codes: None +ShowSessionsStats=1 + +# Show pages-url chart. +# Context: Web, Streaming, Ftp +# Default: PBEX, Possible column codes: PBEX +ShowPagesStats=PBEX + +# Show file types chart. +# Context: Web, Streaming, Ftp +# Default: HB, Possible column codes: HBC +ShowFileTypesStats=HB + +# Show file size chart (Not yet available) +# Context: Web, Streaming, Mail, Ftp +# Default: 1, Possible column codes: None +ShowFileSizesStats=0 + +# Show downloads chart. +# Context: Web, Streaming, Ftp +# Default: HB, Possible column codes: HB +ShowDownloadsStats=HB + +# Show operating systems chart +# Context: Web, Streaming, Ftp +# Default: 1, Possible column codes: None +ShowOSStats=1 + +# Show browsers chart +# Context: Web, Streaming +# Default: 1, Possible column codes: None +ShowBrowsersStats=1 + +# Show screen size chart +# Context: Web, Streaming +# Default: 0 (If set to 1, see also MiscTrackerUrl), Possible column codes: None +ShowScreenSizeStats=0 + +# Show origin chart +# Context: Web, Streaming +# Default: PH, Possible column codes: PH +ShowOriginStats=PH + +# Show keyphrases chart +# Context: Web, Streaming +# Default: 1, Possible column codes: None +ShowKeyphrasesStats=1 + +# Show keywords chart +# Context: Web, Streaming +# Default: 1, Possible column codes: None +ShowKeywordsStats=1 + +# Show misc chart +# Context: Web, Streaming +# Default: a (See also MiscTrackerUrl parameter), Possible column codes: anjdfrqwp +ShowMiscStats=a + +# Show http errors chart +# Context: Web, Streaming +# Default: 1, Possible column codes: None +ShowHTTPErrorsStats=1 + +# Show smtp errors chart (For use when analyzing mail log files) +# Context: Mail +# Default: 0, Possible column codes: None +ShowSMTPErrorsStats=0 + +# Show the cluster report (Your LogFormat must contains the %cluster tag) +# Context: Web, Streaming, Ftp +# Default: 0, Possible column codes: PHB +ShowClusterStats=0 + + +# Some graphical reports are followed by the data array of values. +# If you don't want this array (to reduce the report size for example), you +# can set thoose options to 0. +# Possible values: 0 or 1 +# Default: 1 +# +# Data array values for the ShowMonthStats report +AddDataArrayMonthStats=1 +# Data array values for the ShowDaysOfMonthStats report +AddDataArrayShowDaysOfMonthStats=1 +# Data array values for the ShowDaysOfWeekStats report +AddDataArrayShowDaysOfWeekStats=1 +# Data array values for the ShowHoursStats report +AddDataArrayShowHoursStats=1 + + +# In the Origin chart, you have stats on where your hits came from. You can +# include hits on pages that come from pages of same sites in this chart. +# Possible values: 0 or 1 +# Default: 0 +# +IncludeInternalLinksInOriginSection=0 + + +# The following parameters can be used to choose the maximum number of lines +# shown for the particular following reports. +# +# Stats by countries/domains +MaxNbOfDomain = 10 +MinHitDomain = 1 +# Stats by hosts +MaxNbOfHostsShown = 10 +MinHitHost = 1 +# Stats by authenticated users +MaxNbOfLoginShown = 10 +MinHitLogin = 1 +# Stats by robots +MaxNbOfRobotShown = 10 +MinHitRobot = 1 +# Stats for Downloads +MaxNbOfDownloadsShown = 10 +MinHitDownloads = 1 +# Stats by pages +MaxNbOfPageShown = 10 +MinHitFile = 1 +# Stats by OS +MaxNbOfOsShown = 10 +MinHitOs = 1 +# Stats by browsers +MaxNbOfBrowsersShown = 10 +MinHitBrowser = 1 +# Stats by screen size +MaxNbOfScreenSizesShown = 5 +MinHitScreenSize = 1 +# Stats by window size (following 2 parameters are not yet used) +MaxNbOfWindowSizesShown = 5 +MinHitWindowSize = 1 +# Stats by referers +MaxNbOfRefererShown = 10 +MinHitRefer = 1 +# Stats for keyphrases +MaxNbOfKeyphrasesShown = 10 +MinHitKeyphrase = 1 +# Stats for keywords +MaxNbOfKeywordsShown = 10 +MinHitKeyword = 1 +# Stats for sender or receiver emails +MaxNbOfEMailsShown = 20 +MinHitEMail = 1 + + +# Choose if you want the week report to start on sunday or monday +# Possible values: +# 0 - Week starts on sunday +# 1 - Week starts on monday +# Default: 1 +# +FirstDayOfWeek=1 + + +# List of visible flags that link to other language translations. +# See Lang parameter for list of allowed flag/language codes. +# If you don't want any flag link, set ShowFlagLinks to "". +# This parameter is used only if ShowMenu parameter is set to 1. +# Possible values: "" or "language_codes_separated_by_space" +# Example: "en es fr nl de" +# Default: "" +# +ShowFlagLinks="" + + +# Each URL, shown in stats report views, are links you can click. +# Possible values: 0 or 1 +# Default: 1 +# +ShowLinksOnUrl=1 + + +# When AWStats builds HTML links in its report pages, it starts those links +# with "http://". However some links might be HTTPS links, so you can enter +# here the root of all your HTTPS links. If all your site is a SSL web site, +# just enter "/". +# This parameter is not used if ShowLinksOnUrl is 0. +# Example: "/shopping" +# Example: "/" +# Default: "" +# +UseHTTPSLinkForUrl="" + + +# Maximum length of URL part shown on stats page (number of characters). +# This affects only URL visible text, links still work. +# Default: 64 +# +MaxLengthOfShownURL=64 + + +# You can enter HTML code that will be added at the top of AWStats reports. +# Default: "" +# +HTMLHeadSection="" + + +# You can enter HTML code that will be added at the end of AWStats reports. +# Great to add advert ban. +# Default: "" +# +HTMLEndSection="" + + +# By default AWStats page contains meta tag robots=noindex,nofollow +# If you want to have your statistics to be indexed, set this option to 1. +# Default: 0 +# +MetaRobot=0 + + +# You can set Logo and LogoLink to use your own logo. +# Logo must be the name of image file (must be in $DirIcons/other directory). +# LogoLink is the expected URL when clicking on Logo. +# Default: "awstats_logo6.png" +# +Logo="awstats_logo6.png" +LogoLink="http://awstats.sourceforge.net" + + +# Value of maximum bar width/height for horizontal/vertical HTML graphics bars. +# Default: 260/90 +# +BarWidth = 260 +BarHeight = 90 + + +# You can ask AWStats to use a particular CSS (Cascading Style Sheet) to +# change its look. To create a style sheet, you can use samples provided with +# AWStats in wwwroot/css directory. +# Example: "/awstatscss/awstats_bw.css" +# Example: "/css/awstats_bw.css" +# Default: "" +# +StyleSheet="" + + +# Those color parameters can be used (if StyleSheet parameter is not used) +# to change AWStats look. +# Example: color_name="RRGGBB" # RRGGBB is Red Green Blue components in Hex +# +color_Background="FFFFFF" # Background color for main page (Default = "FFFFFF") +color_TableBGTitle="CCCCDD" # Background color for table title (Default = "CCCCDD") +color_TableTitle="000000" # Table title font color (Default = "000000") +color_TableBG="CCCCDD" # Background color for table (Default = "CCCCDD") +color_TableRowTitle="FFFFFF" # Table row title font color (Default = "FFFFFF") +color_TableBGRowTitle="ECECEC" # Background color for row title (Default = "ECECEC") +color_TableBorder="ECECEC" # Table border color (Default = "ECECEC") +color_text="000000" # Color of text (Default = "000000") +color_textpercent="606060" # Color of text for percent values (Default = "606060") +color_titletext="000000" # Color of text title within colored Title Rows (Default = "000000") +color_weekend="EAEAEA" # Color for week-end days (Default = "EAEAEA") +color_link="0011BB" # Color of HTML links (Default = "0011BB") +color_hover="605040" # Color of HTML on-mouseover links (Default = "605040") +color_u="FFAA66" # Background color for number of unique visitors (Default = "FFAA66") +color_v="F4F090" # Background color for number of visites (Default = "F4F090") +color_p="4477DD" # Background color for number of pages (Default = "4477DD") +color_h="66DDEE" # Background color for number of hits (Default = "66DDEE") +color_k="2EA495" # Background color for number of bytes (Default = "2EA495") +color_s="8888DD" # Background color for number of search (Default = "8888DD") +color_e="CEC2E8" # Background color for number of entry pages (Default = "CEC2E8") +color_x="C1B2E2" # Background color for number of exit pages (Default = "C1B2E2") + + + +#----------------------------------------------------------------------------- +# PLUGINS +#----------------------------------------------------------------------------- + +# Add here all plugin files you want to load. +# Plugin files must be .pm files stored in 'plugins' directory. +# Uncomment LoadPlugin lines to enable a plugin after checking that perl +# modules required by the plugin are installed. + +# PLUGIN: Tooltips +# REQUIRED MODULES: None +# PARAMETERS: None +# DESCRIPTION: Add tooltips pop-up help boxes to HTML report pages. +# NOTE: This will increased HTML report pages size, thus server load and bandwidth. +# +#LoadPlugin="tooltips" + +# PLUGIN: DecodeUTFKeys +# REQUIRED MODULES: Encode and URI::Escape +# PARAMETERS: None +# DESCRIPTION: Allow AWStats to show correctly (in language charset) +# keywords/keyphrases strings even if they were UTF8 coded by the +# referer search engine. +# +#LoadPlugin="decodeutfkeys" + +# PLUGIN: IPv6 +# PARAMETERS: None +# REQUIRED MODULES: Net::IP and Net::DNS +# DESCRIPTION: This plugin gives AWStats capability to make reverse DNS +# lookup on IPv6 addresses. +# +#LoadPlugin="ipv6" + +# PLUGIN: HashFiles +# REQUIRED MODULES: Storable +# PARAMETERS: None +# DESCRIPTION: AWStats DNS cache files are read/saved as native hash files. +# This increases DNS cache files loading speed, above all for very large web sites. +# +#LoadPlugin="hashfiles" + + +# PLUGIN: UserInfo +# REQUIRED MODULES: None +# PARAMETERS: None +# DESCRIPTION: Add a text (Firtname, Lastname, Office Department, ...) in +# authenticated user reports for each login value. +# A text file called userinfo.myconfig.txt, with two fields (first is login, +# second is text to show, separated by a tab char) must be created in DirData +# directory. +# +#LoadPlugin="userinfo" + +# PLUGIN: HostInfo +# REQUIRED MODULES: Net::XWhois +# PARAMETERS: None +# DESCRIPTION: Add a column into host chart with a link to open a popup window that shows +# info on host (like whois records). +# +#LoadPlugin="hostinfo" + +# PLUGIN: ClusterInfo +# REQUIRED MODULES: None +# PARAMETERS: None +# DESCRIPTION: Add a text (for example a full hostname) in cluster reports for each cluster +# number. A text file called clusterinfo.myconfig.txt, with two fields (first is +# cluster number, second is text to show) separated by a tab char. must be +# created into DirData directory. +# Note this plugin is useless if ShowClusterStats is set to 0 or if you don't +# use a personalized log format that contains %cluster tag. +# +#LoadPlugin="clusterinfo" + +# PLUGIN: UrlAliases +# REQUIRED MODULES: None +# PARAMETERS: None +# DESCRIPTION: Add a text (Page title, description...) in URL reports before URL value. +# A text file called urlalias.myconfig.txt, with two fields (first is URL, +# second is text to show, separated by a tab char) must be created into +# DirData directory. +# +#LoadPlugin="urlalias" + +# PLUGIN: TimeHiRes +# REQUIRED MODULES: Time::HiRes (if Perl < 5.8) +# PARAMETERS: None +# DESCRIPTION: Time reported by -showsteps option is in millisecond. For debug purpose. +# +#LoadPlugin="timehires" + +# PLUGIN: TimeZone +# REQUIRED MODULES: Time::Local +# PARAMETERS: [timezone offset] +# DESCRIPTION: Allow AWStats to adjust time stamps for a different timezone +# This plugin reduces AWStats speed of 10% !!!!!!! +# LoadPlugin="timezone" +# LoadPlugin="timezone +2" +# LoadPlugin="timezone CET" +# +#LoadPlugin="timezone +2" + +# PLUGIN: Rawlog +# REQUIRED MODULES: None +# PARAMETERS: None +# DESCRIPTION: This plugin adds a form in AWStats main page to allow users to see raw +# content of current log files. A filter is also available. +# +#LoadPlugin="rawlog" + +# PLUGIN: GraphApplet +# REQUIRED MODULES: None +# PARAMETERS: [CSS classes to override] +# DESCRIPTION: Supported charts are built by a 3D graphic applet. +# +#LoadPlugin="graphapplet /awstatsclasses" # EXPERIMENTAL FEATURE + +# PLUGIN: GraphGoogleChartAPI +# REQUIRED MODULES: None +# PARAMETERS: None +# DESCRIPTION: Replaces the standard charts with free Google API generated images +# in HTML reports. If country data is available and more than one country has hits, +# a map will be generated using Google Visualizations. +# Note: The machine where reports are displayed must have Internet access for the +# charts to be generated. The only data sent to Google includes the statistic numbers, +# legend names and country names. +# Warning: This plugin is not compatible with option BuildReportFormat=xhtml. +# +#LoadPlugin="graphgooglechartapi" + +# PLUGIN: GeoIPfree +# REQUIRED MODULES: Geo::IPfree version 0.2+ (from Graciliano M.P.) +# PARAMETERS: None +# DESCRIPTION: Country chart is built from an Internet IP-Country database. +# This plugin is useless for intranet only log files. +# Note: You must choose between using this plugin (need Perl Geo::IPfree +# module, database is free but not up to date) or the GeoIP plugin (need +# Perl Geo::IP module from Maxmind, database is also free and up to date). +# Note: Activestate provide a corrupted version of Geo::IPfree 0.2 Perl +# module, so install it from elsewhere (from www.cpan.org for example). +# This plugin reduces AWStats speed by up to 10% ! +# +#LoadPlugin="geoipfree" + +# MAXMIND GEO IP MODULES: Please see documentation for notes on all Maxmind modules + +# PLUGIN: GeoIP +# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind) +# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/geoip.dat[+/pathto/override.txt]] +# DESCRIPTION: Builds a country chart and adds an entry to the hosts +# table with country name +# Replace spaces in the path of geoip data file with string "%20". +# +#LoadPlugin="geoip GEOIP_STANDARD /pathto/GeoIP.dat" + +# PLUGIN: GeoIP_City_Maxmind +# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind) +# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPCity.dat[+/pathto/override.txt]] +# DESCRIPTION: This plugin adds a column under the hosts field and tracks the pageviews +# and hits by city including regions. +# Replace spaces in the path of geoip data file with string "%20". +# +#LoadPlugin="geoip_city_maxmind GEOIP_STANDARD /pathto/GeoIPCity.dat" + +# PLUGIN: GeoIP_ASN_Maxmind +# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind) +# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPASN.dat[+/pathto/override.txt][+http://linktoASlookup]] +# DESCRIPTION: This plugin adds a chart of AS numbers where the host IP address is registered. +# This plugin can display some ISP information if included in the database. You can also provide +# a link that will be used to lookup additional registration data. Put the link at the end of +# the parameter string and the report page will include the link with the full AS number at the end. +# Replace spaces in the path of geoip data file with string "%20". +# +#LoadPlugin="geoip_asn_maxmind GEOIP_STANDARD /usr/local/geoip.dat+http://enc.com.au/itools/aut-num.php?autnum=" + +# PLUGIN: GeoIP_Region_Maxmind +# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind) +# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPRegion.dat[+/pathto/override.txt]] +# DESCRIPTION:This plugin adds a chart of hits by regions. Only regions for US and +# Canada can be detected. +# Replace spaces in the path of geoip data file with string "%20". +# +#LoadPlugin="geoip_region_maxmind GEOIP_STANDARD /pathto/GeoIPRegion.dat" + +# PLUGIN: GeoIP_ISP_Maxmind +# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind) +# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPISP.dat[+/pathto/override.txt]] +# DESCRIPTION: This plugin adds a chart of hits by ISP. +# Replace spaces in the path of geoip data file with string "%20". +# +#LoadPlugin="geoip_isp_maxmind GEOIP_STANDARD /pathto/GeoIPISP.dat" + +# PLUGIN: GeoIP_Org_Maxmind +# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind) +# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPOrg.dat[+/pathto/override.txt]] +# DESCRIPTION: This plugin add a chart of hits by Organization name +# Replace spaces in the path of geoip data file with string "%20". +# +#LoadPlugin="geoip_org_maxmind GEOIP_STANDARD /pathto/GeoIPOrg.dat" + + +#----------------------------------------------------------------------------- +# EXTRA SECTIONS +#----------------------------------------------------------------------------- + +# You can define your own charts, you choose here what are rows and columns +# keys. This feature is particularly useful for marketing purpose, tracking +# products orders for example. +# For this, edit all parameters of Extra section. Each set of parameter is a +# different chart. For several charts, duplicate section changing the number. +# Note: Each Extra section reduces AWStats speed by 8%. +# +# WARNING: A wrong setup of Extra section might result in too large arrays +# that will consume all your memory, making AWStats unusable after several +# updates, so be sure to setup it correctly. +# In most cases, you don't need this feature. +# +# ExtraSectionNameX is title of your personalized chart. +# ExtraSectionCodeFilterX is list of codes the record code field must match. +# Put an empty string for no test on code. +# ExtraSectionConditionX are conditions you can use to count or not the hit, +# Use one of the field condition +# (URL,URLWITHQUERY,QUERY_STRING,REFERER,UA,HOSTINLOG,HOST,VHOST,extraX) +# and a regex to match, after a coma. Use "||" for "OR". +# ExtraSectionFirstColumnTitleX is the first column title of the chart. +# ExtraSectionFirstColumnValuesX is a string to tell AWStats which field to +# extract value from +# (URL,URLWITHQUERY,QUERY_STRING,REFERER,UA,HOSTINLOG,HOST,VHOST,extraX) +# and how to extract the value (using regex syntax). Each different value +# found will appear in first column of report on a different row. Be sure +# that list of different possible values will not grow indefinitely. +# ExtraSectionFirstColumnFormatX is the string used to write value. +# ExtraSectionStatTypesX are things you want to count. You can use standard +# code letters (P for pages,H for hits,B for bandwidth,L for last access). +# ExtraSectionAddAverageRowX add a row at bottom of chart with average values. +# ExtraSectionAddSumRowX add a row at bottom of chart with sum values. +# MaxNbOfExtraX is maximum number of rows shown in chart. +# MinHitExtraX is minimum number of hits required to be shown in chart. +# + +# Example to report the 20 products the most ordered by "order.cgi" script +#ExtraSectionName1="Product orders" +#ExtraSectionCodeFilter1="200 304" +#ExtraSectionCondition1="URL,\/cgi\-bin\/order\.cgi||URL,\/cgi\-bin\/order2\.cgi" +#ExtraSectionFirstColumnTitle1="Product ID" +#ExtraSectionFirstColumnValues1="QUERY_STRING,productid=([^&]+)" +#ExtraSectionFirstColumnFormat1="%s" +#ExtraSectionStatTypes1=PL +#ExtraSectionAddAverageRow1=0 +#ExtraSectionAddSumRow1=1 +#MaxNbOfExtra1=20 +#MinHitExtra1=1 + + +# There is also a global parameter ExtraTrackedRowsLimit that limits the +# number of possible rows an ExtraSection can report. This parameter is +# here to protect too much memory use when you make a bad setup in your +# ExtraSection. It applies to all ExtraSection independently meaning that +# none ExtraSection can report more rows than value defined by ExtraTrackedRowsLimit. +# If you know an ExtraSection will report more rows than its value, you should +# increase this parameter or AWStats will stop with an error. +# Example: 2000 +# Default: 500 +# +ExtraTrackedRowsLimit=500 + + +#----------------------------------------------------------------------------- +# INCLUDES +#----------------------------------------------------------------------------- + +# You can include other config files using the directive with the name of the +# config file. +# This is particularly useful for users who have a lot of virtual servers, so +# a lot of config files and want to maintain common values in only one file. +# Note that when a variable is defined both in a config file and in an +# included file, AWStats will use the last value read for parameters that +# contains one value and AWStats will concat all values from both files for +# parameters that are lists of values. +# + +#Include "" + diff --git a/configuration/environments_scripts/central_reverse_proxy/files/etc/awstats/awstats.www.sapsailing.com.conf b/configuration/environments_scripts/central_reverse_proxy/files/etc/awstats/awstats.www.sapsailing.com.conf new file mode 100644 index 00000000000..10eaa52dc01 --- /dev/null +++ b/configuration/environments_scripts/central_reverse_proxy/files/etc/awstats/awstats.www.sapsailing.com.conf @@ -0,0 +1,1568 @@ +# AWSTATS CONFIGURE FILE 7.0 +#----------------------------------------------------------------------------- +# Copy this file into awstats.www.mydomain.conf and edit this new config file +# to setup AWStats (See documentation in docs/ directory). +# The config file must be in /etc/awstats, /usr/local/etc/awstats or /etc (for +# Unix/Linux) or same directory than awstats.pl (Windows, Mac, Unix/Linux...) +# To include an environment variable in any parameter (AWStats will replace +# it with its value when reading it), follow the example: +# Parameter="__ENVNAME__" +# Note that environment variable AWSTATS_CURRENT_CONFIG is always defined with +# the config value in an AWStats running session and can be used like others. +#----------------------------------------------------------------------------- +# $Revision: 1.350 $ - $Author: eldy $ - $Date: 2010/09/29 19:16:21 $ + + + +#----------------------------------------------------------------------------- +# MAIN SETUP SECTION (Required to make AWStats work) +#----------------------------------------------------------------------------- + +# "LogFile" contains the web, ftp or mail server log file to analyze. +# Possible values: A full path, or a relative path from awstats.pl directory. +# Example: "/var/log/apache/access.log" +# Example: "../logs/mycombinedlog.log" +# You can also use tags in this filename if you need a dynamic file name +# depending on date or time (Replacement is made by AWStats at the beginning +# of its execution). This is available tags : +# %YYYY-n is replaced with 4 digits year we were n hours ago +# %YY-n is replaced with 2 digits year we were n hours ago +# %MM-n is replaced with 2 digits month we were n hours ago +# %MO-n is replaced with 3 letters month we were n hours ago +# %DD-n is replaced with day we were n hours ago +# %HH-n is replaced with hour we were n hours ago +# %NS-n is replaced with number of seconds at 00:00 since 1970 +# %WM-n is replaced with the week number in month (1-5) +# %Wm-n is replaced with the week number in month (0-4) +# %WY-n is replaced with the week number in year (01-52) +# %Wy-n is replaced with the week number in year (00-51) +# %DW-n is replaced with the day number in week (1-7, 1=sunday) +# use n=24 if you need (1-7, 1=monday) +# %Dw-n is replaced with the day number in week (0-6, 0=sunday) +# use n=24 if you need (0-6, 0=monday) +# Use 0 for n if you need current year, month, day, hour... +# Example: "/var/log/access_log.%YYYY-0%MM-0%DD-0.log" +# Example: "C:/WINNT/system32/LogFiles/W3SVC1/ex%YY-24%MM-24%DD-24.log" +# You can also use a pipe if log file come from a pipe : +# Example: "gzip -d outputpath/output.html"), enter +# path of icon directory relative to the output directory 'outputpath'. +# Example: "/awstatsicons" +# Example: "../icon" +# Default: "/icon" (means you must copy icon directories in "/mywwwroot/icon") +# +DirIcons="/awstatsicons" + + +# When this parameter is set to 1, AWStats adds a button on report page to +# allow to "update" statistics from a web browser. Warning, when "update" is +# made from a browser, AWStats is run as a CGI by the web server user defined +# in your web server (user "nobody" by default with Apache, "IUSR_XXX" with +# IIS), so the "DirData" directory and all already existing history files +# awstatsMMYYYY[.xxx].txt must be writable by this user. Change permissions if +# necessary to "Read/Write" (and "Modify" for Windows NTFS file systems). +# Warning: Update process can be long so you might experience "time out" +# browser errors if you don't launch AWStats frequently enough. +# When set to 0, update is only made when AWStats is run from the command +# line interface (or a task scheduler). +# Possible values: 0 or 1 +# Default: 0 +# +AllowToUpdateStatsFromBrowser=0 + + +# AWStats saves and sorts its database on a month basis (except if using +# databasebreak option from command line). +# However, if you choose the -month=all from command line or +# value '-Year-' from CGI combo form to have a report for all year, AWStats +# needs to reload all data for full year (each month), and sort them, +# requiring a large amount of time, memory and CPU. This might be a problem +# for web hosting providers that offer AWStats for large sites, on shared +# servers, to non CPU cautious customers. +# For this reason, the 'full year' is only enabled on Command Line by default. +# You can change this by setting this parameter to 0, 1, 2 or 3. +# Possible values: +# 0 - Never allowed +# 1 - Allowed on CLI only, -Year- value in combo is not visible +# 2 - Allowed on CLI only, -Year- value in combo is visible but not allowed +# 3 - Possible on CLI and CGI +# Default: 2 +# +AllowFullYearView=3 + + + +#----------------------------------------------------------------------------- +# OPTIONAL SETUP SECTION (Not required but increase AWStats features) +#----------------------------------------------------------------------------- + +# When the update process runs, AWStats can set a lock file in TEMP or TMP +# directory. This lock is to avoid to have 2 update processes running at the +# same time to prevent unknown conflicts problems and avoid DoS attacks when +# AllowToUpdateStatsFromBrowser is set to 1. +# Because, when you use lock file, you can experience sometimes problems in +# lock file not correctly removed (killed process for example requires that +# you remove the file manualy), this option is not enabled by default (Do +# not enable this option with no console server access). +# Change : Effective immediatly +# Possible values: 0 or 1 +# Default: 0 +# +EnableLockForUpdate=1 + + +# AWStats can do reverse DNS lookups through a static DNS cache file that was +# previously created manually. If no path is given in static DNS cache file +# name, AWStats will search DirData directory. This file is never changed. +# This option is not used if DNSLookup=0. +# Note: DNS cache file format is 'minsince1970 ipaddress resolved_hostname' +# or just 'ipaddress resolved_hostname' +# Change : Effective for new updates only +# Example: "/mydnscachedir/dnscache" +# Default: "dnscache.txt" +# +DNSStaticCacheFile="dnscache.txt" + + +# AWStats can do reverse DNS lookups through a DNS cache file that was created +# by a previous run of AWStats. This file is erased and recreated after each +# statistics update process. You don't need to create and/or edit it. +# AWStats will read and save this file in DirData directory. +# This option is used only if DNSLookup=1. +# Note: If a DNSStaticCacheFile is available, AWStats will check for DNS +# lookup in DNSLastUpdateCacheFile after checking into DNSStaticCacheFile. +# Change : Effective for new updates only +# Example: "/mydnscachedir/dnscachelastupdate" +# Default: "dnscachelastupdate.txt" +# +DNSLastUpdateCacheFile="dnscachelastupdate.txt" + + +# You can specify specific IP addresses that should NOT be looked up in DNS. +# This option is used only if DNSLookup=1. +# Note: Use space between each value. +# Note: You can use regular expression values writing value with REGEX[value]. +# Change : Effective for new updates only +# Example: "123.123.123.123 REGEX[^192\.168\.]" +# Default: "" +# +SkipDNSLookupFor="" + + +# The following two parameters allow you to protect a config file from being +# read by AWStats when called from a browser if web user has not been +# authenticated. Your AWStats program must be in a web protected "realm" (With +# Apache, you can use .htaccess files to do so. With other web servers, see +# your server setup manual). +# Change : Effective immediatly +# Possible values: 0 or 1 +# Default: 0 +# +AllowAccessFromWebToAuthenticatedUsersOnly=0 + + +# This parameter gives the list of all authorized authenticated users to view +# statistics for this domain/config file. This parameter is used only if +# AllowAccessFromWebToAuthenticatedUsersOnly is set to 1. +# Change : Effective immediatly +# Example: "user1 user2" +# Example: "__REMOTE_USER__" +# Default: "" +# +AllowAccessFromWebToFollowingAuthenticatedUsers="" + + +# When this parameter is defined to something, the IP address of the user that +# reads its statistics from a browser (when AWStats is used as a CGI) is +# checked and must match one of the IP address values or ranges. +# Change : Effective immediatly +# Example: "127.0.0.1 123.123.123.1-123.123.123.255" +# Default: "" +# +AllowAccessFromWebToFollowingIPAddresses="" + + +# If the "DirData" directory (see above) does not exist, AWStats return an +# error. However, you can ask AWStats to create it. +# This option can be used by some Web Hosting Providers that has defined a +# dynamic value for DirData (for example DirData="/home/__REMOTE_USER__") and +# don't want to have to create a new directory each time they add a new user. +# Change : Effective immediatly +# Possible values: 0 or 1 +# Default: 0 +# +CreateDirDataIfNotExists=0 + + +# You can choose in which format the Awstats history database is saved. +# Note: Using "xml" format make AWStats building database files three times +# larger than using "text" format. +# Change : Database format is switched after next update +# Possible values: text or xml +# Default: text +# +BuildHistoryFormat=text + + +# If you prefer having the report output pages be built as XML compliant pages +# instead of simple HTML pages, you can set this to 'xhtml' (May not work +# properly with old browsers). +# Change : Effective immediatly +# Possible values: html or xhtml +# Default: html +# +BuildReportFormat=html + + +# AWStats databases can be updated from command line of from a browser (when +# used as a cgi program). So AWStats database files need write permission +# for both command line user and default web server user (nobody for Unix, +# IUSR_xxx for IIS/Windows,...). +# To avoid permission problems between update process (run by an admin user) +# and CGI process (ran by a low level user), AWStats can save its database +# files with read and write permissions for everyone. +# By default, AWStats keeps default user permissions on updated files. If you +# set AllowToUpdateStatsFromBrowser to 1, you can change this parameter to 1. +# Change : Effective for new updates only +# Possible values: 0 or 1 +# Default: 0 +# +SaveDatabaseFilesWithPermissionsForEveryone=0 + + +# AWStats can purge log file, after analyzing it. Note that AWStats is able +# to detect new lines in a log file, to process only them, so you can launch +# AWStats as often as you want, even with this parameter to 0. +# With 0, no purge is made, so you must use a scheduled task or a web server +# that make this purge frequently. +# With 1, the purge of the log file is made each time AWStats update is run. +# This parameter doesn't work with IIS (This web server doesn't let its log +# file to be purged). +# Change : Effective for new updates only +# Possible values: 0 or 1 +# Default: 0 +# +PurgeLogFile=0 + + +# When PurgeLogFile is setup to 1, AWStats will clean your log file after +# processing it. You can however keep an archive file of all processed log +# records by setting this parameter (For example if you want to use another +# log analyzer). The archived log file is saved in "DirData" with name +# awstats_archive.configname[.suffix].log +# This parameter is not used if PurgeLogFile=0 +# Change : Effective for new updates only +# Possible values: 0, 1, or tags (See LogFile parameter) for suffix +# Example: 1 +# Example: %YYYY%MM%DD +# Default: 0 +# +ArchiveLogRecords=0 + + +# Each time you run the update process, AWStats overwrites the 'historic file' +# for the month (awstatsMMYYYY[.*].txt) with the updated one. +# When write errors occurs (IO, disk full,...), this historic file can be +# corrupted and must be deleted. Because this file contains information of all +# past processed log files, you will loose old stats if removed. So you can +# ask AWStats to save last non corrupted file in a .bak file. This file is +# stored in "DirData" directory with other 'historic files'. +# Change : Effective for new updates only +# Possible values: 0 or 1 +# Default: 0 +# +KeepBackupOfHistoricFiles=0 + + +# Default index page name for your web server. +# Change : Effective for new updates only +# Example: "index.php index.html default.html" +# Default: "index.php index.html" +# +DefaultFile="index.php index.html" + + +# Do not include access from clients that match following criteria. +# If your log file contains IP addresses in host field, you must enter here +# matching IP addresses criteria. +# If DNS lookup is already done in your log file, you must enter here hostname +# criteria, else enter ip address criteria. +# The opposite parameter of "SkipHosts" is "OnlyHosts". +# Note: Use space between each value. This parameter is not case sensitive. +# Note: You can use regular expression values writing value with REGEX[value]. +# Change : Effective for new updates only +# Example: "127.0.0.1 REGEX[^192\.168\.] REGEX[^10\.]" +# Example: "localhost REGEX[^.*\.localdomain$]" +# Default: "" +# +SkipHosts="127.0.0.1" + + +# Do not include access from clients with a user agent that match following +# criteria. If you want to exclude a robot, you should update the robots.pm +# file instead of this parameter. +# The opposite parameter of "SkipUserAgents" is "OnlyUserAgents". +# Note: Use space between each value. This parameter is not case sensitive. +# Note: You can use regular expression values writing value with REGEX[value]. +# Change : Effective for new updates only +# Example: "konqueror REGEX[ua_test_v\d\.\d]" +# Default: "" +# +SkipUserAgents="" + + +# Use SkipFiles to ignore access to URLs that match one of following entries. +# You can enter a list of not important URLs (like framed menus, hidden pages, +# etc...) to exclude them from statistics. You must enter here exact relative +# URL as found in log file, or a matching REGEX value. Check apply on URL with +# all its query paramaters. +# For example, to ignore /badpage.php, just add "/badpage.php". To ignore all +# pages in a particular directory, add "REGEX[^\/directorytoexclude]". +# The opposite parameter of "SkipFiles" is "OnlyFiles". +# Note: Use space between each value. This parameter is or not case sensitive +# depending on URLNotCaseSensitive parameter. +# Note: You can use regular expression values writing value with REGEX[value]. +# Change : Effective for new updates only +# Example: "/badpage.php /page.php?param=x REGEX[^\/excludedirectory]" +# Default: "" +# +SkipFiles="" + + +# Use SkipReferrersBlackList if you want to exclude records coming from a SPAM +# referrer. Parameter must receive a local file name containing rules applied +# on referrer field. If parameter is empty, no filter is applied. +# An example of such a file is available in lib/blacklist.txt +# Change : Effective for new updates only +# Example: "/mylibpath/blacklist.txt" +# Default: "" +# +# WARNING!! Using this feature make AWStats running very slower (5 times slower +# with black list file provided with AWStats ! +# +SkipReferrersBlackList="" + + +# Include in stats, only accesses from hosts that match one of following +# entries. For example, if you want AWStats to filter access to keep only +# stats for visits from particular hosts, you can add those host names in +# this parameter. +# If DNS lookup is already done in your log file, you must enter here hostname +# criteria, else enter ip address criteria. +# The opposite parameter of "OnlyHosts" is "SkipHosts". +# Note: Use space between each value. This parameter is not case sensitive. +# Note: You can use regular expression values writing value with REGEX[value]. +# Change : Effective for new updates only +# Example: "127.0.0.1 REGEX[^192\.168\.] REGEX[^10\.]" +# Default: "" +# +OnlyHosts="" + + +# Include in stats, only accesses from user agent that match one of following +# entries. For example, if you want AWStats to filter access to keep only +# stats for visits from particular browsers, you can add their user agents +# string in this parameter. +# The opposite parameter of "OnlyUserAgents" is "SkipUserAgents". +# Note: Use space between each value. This parameter is not case sensitive. +# Note: You can use regular expression values writing value with REGEX[value]. +# Change : Effective for new updates only +# Example: "msie" +# Default: "" +# +OnlyUserAgents="" + + +# Include in stats, only accesses from authenticated users that match one of +# following entries. For example, if you want AWStats to filter access to keep +# only stats for authenticated users, you can add those users names in +# this parameter. Useful for statistics for per user ftp logs. +# Note: Use space between each value. This parameter is not case sensitive. +# Note: You can use regular expression values writing value with REGEX[value]. +# Change : Effective for new updates only +# Example: "john bob REGEX[^testusers]" +# Default: "" +# +OnlyUsers="" + + +# Include in stats, only accesses to URLs that match one of following entries. +# For example, if you want AWStats to filter access to keep only stats that +# match a particular string, like a particular directory, you can add this +# directory name in this parameter. +# The opposite parameter of "OnlyFiles" is "SkipFiles". +# Note: Use space between each value. This parameter is or not case sensitive +# depending on URLNotCaseSensitive parameter. +# Note: You can use regular expression values writing value with REGEX[value]. +# Change : Effective for new updates only +# Example: "REGEX[marketing_directory] REGEX[office\/.*\.(csv|sxw)$]" +# Default: "" +# +OnlyFiles="" + + +# Add here a list of kind of url (file extension) that must be counted as +# "Hit only" and not as a "Hit" and "Page/Download". You can set here all +# image extensions as they are hit downloaded that must be counted but they +# are not viewed pages. URLs with such extensions are not included in the TOP +# Pages/URL report. +# Note: If you want to exclude particular URLs from stats (No Pages and no +# Hits reported), you must use SkipFiles parameter. +# Change : Effective for new updates only +# Example: "css js class gif jpg jpeg png bmp ico rss xml swf zip arj rar gz z bz2 wav mp3 wma mpg avi" +# Example: "" +# Default: "css js class gif jpg jpeg png bmp ico rss xml swf" +# +NotPageList="css js class gif jpg jpeg png bmp ico rss xml swf" + + +# By default, AWStats considers that records found in web log file are +# successful hits if HTTP code returned by server is a valid HTTP code (200 +# and 304). Any other code are reported in HTTP status chart. +# Note that HTTP 'control codes', like redirection (302, 305) are not added by +# default in this list as they are not pages seen by a visitor but are +# protocol exchange codes to tell the browser to ask another page. Because +# this other page will be counted and seen with a 200 or 304 code, if you +# add such codes, you will have 2 pages viewed reported for only one in facts. +# Change : Effective for new updates only +# Example: "200 304 302 305" +# Default: "200 304" +# +ValidHTTPCodes="200 304" + + +# By default, AWStats considers that records found in mail log file are +# successful mail transfers if field that represent return code in analyzed +# log file match values defined by this parameter. +# Change : Effective for new updates only +# Example: "1 250 200" +# Default: "1 250" +# +ValidSMTPCodes="1 250" + + +# Some web servers on some Operating systems (IIS-Windows) consider that a +# login with same value but different case are the same login. To tell AWStats +# to also consider them as one, set this parameter to 1. +# Change : Effective for new updates only +# Possible values: 0 or 1 +# Default: 0 +# +AuthenticatedUsersNotCaseSensitive=0 + + +# Some web servers on some Operating systems (IIS-Windows) considers that two +# URLs with same value but different case are the same URL. To tell AWStats to +# also considers them as one, set this parameter to 1. +# Change : Effective for new updates only +# Possible values: 0 or 1 +# Default: 0 +# +URLNotCaseSensitive=0 + + +# Keep or remove the anchor string you can find in some URLs. +# Change : Effective for new updates only +# Possible values: 0 or 1 +# Default: 0 +# +URLWithAnchor=0 + + +# In URL links, "?" char is used to add parameter's list in URLs. Syntax is: +# /mypage.html?param1=value1¶m2=value2 +# However, some servers/sites use also other chars to isolate dynamic part of +# their URLs. You can complete this list with all such characters. +# Change : Effective for new updates only +# Example: "?;," +# Default: "?;" +# +URLQuerySeparators="?;" + + +# Keep or remove the query string to the URL in the statistics for individual +# pages. This is primarily used to differentiate between the URLs of dynamic +# pages. If set to 1, mypage.html?id=x and mypage.html?id=y are counted as two +# different pages. +# Warning, when set to 1, memory required to run AWStats is dramatically +# increased if you have a lot of changing URLs (for example URLs with a random +# id inside). Such web sites should not set this option to 1 or use seriously +# the next parameter URLWithQueryWithOnlyFollowingParameters (or eventually +# URLWithQueryWithoutFollowingParameters). +# Change : Effective for new updates only +# Possible values: +# 0 - URLs are cleaned from the query string (ie: "/mypage.html") +# 1 - Full URL with query string is used (ie: "/mypage.html?p=x&q=y") +# Default: 0 +# +URLWithQuery=0 + + +# When URLWithQuery is on, you will get the full URL with all parameters in +# URL reports. But among thoose parameters, sometimes you don't need a +# particular parameter because it does not identify the page or because it's +# a random ID changing for each access even if URL points to same page. In +# such cases, it is higly recommanded to ask AWStats to keep only parameters +# you need (if you know them) before counting, manipulating and storing URL. +# Enter here list of wanted parameters. For example, with "param", one hit on +# /mypage.cgi?param=abc&id=Yo4UomP9d and /mypage.cgi?param=abc&id=Mu8fdxl3r +# will be reported as 2 hits on /mypage.cgi?param=abc +# This parameter is not used when URLWithQuery is 0 and can't be used with +# URLWithQueryWithoutFollowingParameters. +# Change : Effective for new updates only +# Example: "param" +# Default: "" +# +URLWithQueryWithOnlyFollowingParameters="" + + +# When URLWithQuery is on, you will get the full URL with all parameters in +# URL reports. But among thoose parameters, sometimes you don't need a +# particular parameter because it does not identify the page or because it's +# a random ID changing for each access even if URL points to same page. In +# such cases, it is higly recommanded to ask AWStats to remove such parameters +# from the URL before counting, manipulating and storing URL. Enter here list +# of all non wanted parameters. For example if you enter "id", one hit on +# /mypage.cgi?param=abc&id=Yo4UomP9d and /mypage.cgi?param=abc&id=Mu8fdxl3r +# will be reported as 2 hits on /mypage.cgi?param=abc +# This parameter is not used when URLWithQuery is 0 and can't be used with +# URLWithQueryWithOnlyFollowingParameters. +# Change : Effective for new updates only +# Example: "PHPSESSID jsessionid" +# Default: "" +# +URLWithQueryWithoutFollowingParameters="" + + +# Keep or remove the query string to the referrer URL in the statistics for +# external referrer pages. This is used to differentiate between the URLs of +# dynamic referrer pages. If set to 1, mypage.html?id=x and mypage.html?id=y +# are counted as two different referrer pages. +# Change : Effective for new updates only +# Possible values: +# 0 - Referrer URLs are cleaned from the query string (ie: "/mypage.html") +# 1 - Full URL with query string is used (ie: "/mypage.html?p=x&q=y") +# Default: 0 +# +URLReferrerWithQuery=0 + + +# AWStats can detect setup problems or show you important informations to have +# a better use. Keep this to 1, except if AWStats says you can change it. +# Change : Effective immediatly +# Possible values: 0 or 1 +# Default: 1 +# +WarningMessages=1 + + +# When an error occurs, AWStats outputs a message related to errors. If you +# want (in most cases for security reasons) to have no error messages, you +# can set this parameter to your personalized generic message. +# Change : Effective immediatly +# Example: "An error occurred. Contact your Administrator" +# Default: "" +# +ErrorMessages="" + + +# AWStat can be run with debug=x parameter to output various informations +# to help in debugging or solving troubles. If you want to allow this (not +# enabled by default for security reasons), set this parameter to 0. +# Change : Effective immediatly +# Possible values: 0 or 1 +# Default: 0 +# +DebugMessages=0 + + +# To help you to detect if your log format is good, AWStats reports an error +# if all the first NbOfLinesForCorruptedLog lines have a format that does not +# match the LogFormat parameter. +# However, some worm virus attack on your web server can result in a very high +# number of corrupted lines in your log. So if you experience awstats stop +# because of bad virus records at the beginning of your log file, you can +# increase this parameter (very rare). +# Change : Effective for new updates only +# Default: 50 +# +NbOfLinesForCorruptedLog=50 + + +# For some particular integration needs, you may want to have CGI links to +# point to another script than awstats.pl. +# Use the name of this script in WrapperScript parameter. +# Change : Effective immediatly +# Example: "awstatslauncher.pl" +# Example: "awstatswrapper.cgi?key=123" +# Default: "" +# +WrapperScript="" + + +# DecodeUA must be set to 1 if you use Roxen web server. This server converts +# all spaces in user agent field into %20. This make the AWStats robots, OS +# and browsers detection fail in some cases. Just change it to 1 if and only +# if your web server is Roxen. +# Change : Effective for new updates only +# Possible values: 0 or 1 +# Default: 0 +# +DecodeUA=0 + + +# MiscTrackerUrl can be used to make AWStats able to detect some miscellaneous +# things, that can not be tracked on other way, like: +# - Javascript disabled +# - Java enabled +# - Screen size +# - Color depth +# - Macromedia Director plugin +# - Macromedia Shockwave plugin +# - Realplayer G2 plugin +# - QuickTime plugin +# - Mediaplayer plugin +# - Acrobat PDF plugin +# To enable all these features, you must copy the awstats_misc_tracker.js file +# into a /js/ directory stored in your web document root and add the following +# HTML code at the end of your index page (but before ) : +# +# +# +# +# If code is not added in index page, all those detection capabilities will be +# disabled. You must also check that ShowScreenSizeStats and ShowMiscStats +# parameters are set to 1 to make results appear in AWStats report page. +# If you want to use another directory than /js/, you must also change the +# awstatsmisctrackerurl variable into the awstats_misc_tracker.js file. +# Change : Effective for new updates only. +# Possible value: URL of javascript tracker file added in your HTML code. +# Default: "/js/awstats_misc_tracker.js" +# +MiscTrackerUrl="/js/awstats_misc_tracker.js" + + + +#----------------------------------------------------------------------------- +# OPTIONAL ACCURACY SETUP SECTION (Not required but increase AWStats features) +#----------------------------------------------------------------------------- + +# The following values allow you to define accuracy of AWStats entities +# (robots, browsers, os, referers, file types) detection. +# It might be a good idea for large web sites or ISP that provides AWStats to +# high number of customers, to set this parameter to 1 (or 0), instead of 2. +# Possible values: +# 0 = No detection, +# 1 = Medium/Standard detection +# 2 = Full detection +# Change : Effective for new updates only +# Note : LevelForBrowsersDetection can also accept value "allphones". This +# enable detailed detection of phone/pda browsers. +# Default: 2 (0 for LevelForWormsDetection) +# +LevelForBrowsersDetection=2 # 0 disables Browsers detection. + # 2 reduces AWStats speed by 2% + # allphones reduces AWStats speed by 5% +LevelForOSDetection=2 # 0 disables OS detection. + # 2 reduces AWStats speed by 3% +LevelForRefererAnalyze=2 # 0 disables Origin detection. + # 2 reduces AWStats speed by 14% +LevelForRobotsDetection=2 # 0 disables Robots detection. + # 2 reduces AWStats speed by 2.5% +LevelForSearchEnginesDetection=2 # 0 disables Search engines detection. + # 2 reduces AWStats speed by 9% +LevelForKeywordsDetection=2 # 0 disables Keyphrases/Keywords detection. + # 2 reduces AWStats speed by 1% +LevelForFileTypesDetection=2 # 0 disables File types detection. + # 2 reduces AWStats speed by 1% +LevelForWormsDetection=0 # 0 disables Worms detection. + # 2 reduces AWStats speed by 15% + + + +#----------------------------------------------------------------------------- +# OPTIONAL APPEARANCE SETUP SECTION (Not required but increase AWStats features) +#----------------------------------------------------------------------------- + +# When you use AWStats as a CGI, you can have the reports shown in HTML frames. +# Frames are only available for report viewed dynamically. When you build +# pages from command line, this option is not used and no frames are built. +# Possible values: 0 or 1 +# Default: 1 +# +UseFramesWhenCGI=1 + + +# This parameter asks your browser to open detailed reports into a different +# window than the main page. +# Possible values: +# 0 - Open all in same browser window +# 1 - Open detailed reports in another window except if using frames +# 2 - Open always in a different window even if reports are framed +# Default: 1 +# +DetailedReportsOnNewWindows=1 + + +# You can add, in the HTML report page, a cache lifetime (in seconds) that +# will be returned to the browser in HTTP header answer by server. +# This parameter is not used when reports are built with -staticlinks option. +# Example: 3600 +# Default: 0 +# +Expires=3600 + + +# To avoid too large web pages, you can ask AWStats to limit number of rows of +# all reported charts to this number when no other limits apply. +# Default: 1000 +# +MaxRowsInHTMLOutput=1000 + + +# Set your primary language (ISO-639-1 language codes). +# Possible values: +# Albanian=al, Bosnian=ba, Bulgarian=bg, Catalan=ca, +# Chinese (Taiwan)=tw, Chinese (Simpliefied)=cn, Croatian=hr, Czech=cz, +# Danish=dk, Dutch=nl, English=en, Estonian=et, Euskara=eu, Finnish=fi, +# French=fr, Galician=gl, German=de, Greek=gr, Hebrew=he, Hungarian=hu, +# Icelandic=is, Indonesian=id, Italian=it, Japanese=jp, Korean=ko, +# Latvian=lv, Norwegian (Nynorsk)=nn, Norwegian (Bokmal)=nb, Polish=pl, +# Portuguese=pt, Portuguese (Brazilian)=br, Romanian=ro, Russian=ru, +# Serbian=sr, Slovak=sk, Slovenian=si, Spanish=es, Swedish=se, Turkish=tr, +# Ukrainian=ua, Welsh=cy. +# First available language accepted by browser=auto +# Default: "auto" +# +Lang="auto" + + +# Set the location of language files. +# Example: "/usr/share/awstats/lang" +# Default: "./lang" (means lang directory is in same location than awstats.pl) +# +DirLang="./lang" + + +# Show menu header with reports' links +# Possible values: 0 or 1 +# Default: 1 +# +ShowMenu=1 + + +# You choose here which reports you want to see in the main page and what you +# want to see in those reports. +# Possible values: +# 0 - Report is not shown at all +# 1 - Report is shown in main page with an entry in menu and default columns +# XYZ - Report shows column informations defined by code X,Y,Z... +# X,Y,Z... are code letters among the following: +# U = Unique visitors +# V = Visits +# P = Number of pages +# H = Number of hits (or mails) +# B = Bandwith (or total mail size for mail logs) +# L = Last access date +# E = Entry pages +# X = Exit pages +# C = Web compression (mod_gzip,mod_deflate) +# M = Average mail size (mail logs) +# + +# Show monthly summary +# Context: Web, Streaming, Mail, Ftp +# Default: UVPHB, Possible column codes: UVPHB +ShowSummary=UVPHB + +# Show monthly chart +# Context: Web, Streaming, Mail, Ftp +# Default: UVPHB, Possible column codes: UVPHB +ShowMonthStats=UVPHB + +# Show days of month chart +# Context: Web, Streaming, Mail, Ftp +# Default: VPHB, Possible column codes: VPHB +ShowDaysOfMonthStats=VPHB + +# Show days of week chart +# Context: Web, Streaming, Mail, Ftp +# Default: PHB, Possible column codes: PHB +ShowDaysOfWeekStats=PHB + +# Show hourly chart +# Context: Web, Streaming, Mail, Ftp +# Default: PHB, Possible column codes: PHB +ShowHoursStats=PHB + +# Show domains/country chart +# Context: Web, Streaming, Mail, Ftp +# Default: PHB, Possible column codes: PHB +ShowDomainsStats=PHB + +# Show hosts chart +# Context: Web, Streaming, Mail, Ftp +# Default: PHBL, Possible column codes: PHBL +ShowHostsStats=PHBL + +# Show authenticated users chart +# Context: Web, Streaming, Ftp +# Default: 0, Possible column codes: PHBL +ShowAuthenticatedUsers=0 + +# Show robots chart +# Context: Web, Streaming +# Default: HBL, Possible column codes: HBL +ShowRobotsStats=HBL + +# Show worms chart +# Context: Web, Streaming +# Default: 0 (If set to other than 0, see also LevelForWormsDetection), Possible column codes: HBL +ShowWormsStats=0 + +# Show email senders chart (For use when analyzing mail log files) +# Context: Mail +# Default: 0, Possible column codes: HBML +ShowEMailSenders=0 + +# Show email receivers chart (For use when analyzing mail log files) +# Context: Mail +# Default: 0, Possible column codes: HBML +ShowEMailReceivers=0 + +# Show session chart +# Context: Web, Streaming, Ftp +# Default: 1, Possible column codes: None +ShowSessionsStats=1 + +# Show pages-url chart. +# Context: Web, Streaming, Ftp +# Default: PBEX, Possible column codes: PBEX +ShowPagesStats=PBEX + +# Show file types chart. +# Context: Web, Streaming, Ftp +# Default: HB, Possible column codes: HBC +ShowFileTypesStats=HB + +# Show file size chart (Not yet available) +# Context: Web, Streaming, Mail, Ftp +# Default: 1, Possible column codes: None +ShowFileSizesStats=0 + +# Show downloads chart. +# Context: Web, Streaming, Ftp +# Default: HB, Possible column codes: HB +ShowDownloadsStats=HB + +# Show operating systems chart +# Context: Web, Streaming, Ftp +# Default: 1, Possible column codes: None +ShowOSStats=1 + +# Show browsers chart +# Context: Web, Streaming +# Default: 1, Possible column codes: None +ShowBrowsersStats=1 + +# Show screen size chart +# Context: Web, Streaming +# Default: 0 (If set to 1, see also MiscTrackerUrl), Possible column codes: None +ShowScreenSizeStats=0 + +# Show origin chart +# Context: Web, Streaming +# Default: PH, Possible column codes: PH +ShowOriginStats=PH + +# Show keyphrases chart +# Context: Web, Streaming +# Default: 1, Possible column codes: None +ShowKeyphrasesStats=1 + +# Show keywords chart +# Context: Web, Streaming +# Default: 1, Possible column codes: None +ShowKeywordsStats=1 + +# Show misc chart +# Context: Web, Streaming +# Default: a (See also MiscTrackerUrl parameter), Possible column codes: anjdfrqwp +ShowMiscStats=a + +# Show http errors chart +# Context: Web, Streaming +# Default: 1, Possible column codes: None +ShowHTTPErrorsStats=1 + +# Show smtp errors chart (For use when analyzing mail log files) +# Context: Mail +# Default: 0, Possible column codes: None +ShowSMTPErrorsStats=0 + +# Show the cluster report (Your LogFormat must contains the %cluster tag) +# Context: Web, Streaming, Ftp +# Default: 0, Possible column codes: PHB +ShowClusterStats=0 + + +# Some graphical reports are followed by the data array of values. +# If you don't want this array (to reduce the report size for example), you +# can set thoose options to 0. +# Possible values: 0 or 1 +# Default: 1 +# +# Data array values for the ShowMonthStats report +AddDataArrayMonthStats=1 +# Data array values for the ShowDaysOfMonthStats report +AddDataArrayShowDaysOfMonthStats=1 +# Data array values for the ShowDaysOfWeekStats report +AddDataArrayShowDaysOfWeekStats=1 +# Data array values for the ShowHoursStats report +AddDataArrayShowHoursStats=1 + + +# In the Origin chart, you have stats on where your hits came from. You can +# include hits on pages that come from pages of same sites in this chart. +# Possible values: 0 or 1 +# Default: 0 +# +IncludeInternalLinksInOriginSection=0 + + +# The following parameters can be used to choose the maximum number of lines +# shown for the particular following reports. +# +# Stats by countries/domains +MaxNbOfDomain = 10 +MinHitDomain = 1 +# Stats by hosts +MaxNbOfHostsShown = 10 +MinHitHost = 1 +# Stats by authenticated users +MaxNbOfLoginShown = 10 +MinHitLogin = 1 +# Stats by robots +MaxNbOfRobotShown = 10 +MinHitRobot = 1 +# Stats for Downloads +MaxNbOfDownloadsShown = 10 +MinHitDownloads = 1 +# Stats by pages +MaxNbOfPageShown = 10 +MinHitFile = 1 +# Stats by OS +MaxNbOfOsShown = 10 +MinHitOs = 1 +# Stats by browsers +MaxNbOfBrowsersShown = 10 +MinHitBrowser = 1 +# Stats by screen size +MaxNbOfScreenSizesShown = 5 +MinHitScreenSize = 1 +# Stats by window size (following 2 parameters are not yet used) +MaxNbOfWindowSizesShown = 5 +MinHitWindowSize = 1 +# Stats by referers +MaxNbOfRefererShown = 10 +MinHitRefer = 1 +# Stats for keyphrases +MaxNbOfKeyphrasesShown = 10 +MinHitKeyphrase = 1 +# Stats for keywords +MaxNbOfKeywordsShown = 10 +MinHitKeyword = 1 +# Stats for sender or receiver emails +MaxNbOfEMailsShown = 20 +MinHitEMail = 1 + + +# Choose if you want the week report to start on sunday or monday +# Possible values: +# 0 - Week starts on sunday +# 1 - Week starts on monday +# Default: 1 +# +FirstDayOfWeek=1 + + +# List of visible flags that link to other language translations. +# See Lang parameter for list of allowed flag/language codes. +# If you don't want any flag link, set ShowFlagLinks to "". +# This parameter is used only if ShowMenu parameter is set to 1. +# Possible values: "" or "language_codes_separated_by_space" +# Example: "en es fr nl de" +# Default: "" +# +ShowFlagLinks="" + + +# Each URL, shown in stats report views, are links you can click. +# Possible values: 0 or 1 +# Default: 1 +# +ShowLinksOnUrl=1 + + +# When AWStats builds HTML links in its report pages, it starts those links +# with "http://". However some links might be HTTPS links, so you can enter +# here the root of all your HTTPS links. If all your site is a SSL web site, +# just enter "/". +# This parameter is not used if ShowLinksOnUrl is 0. +# Example: "/shopping" +# Example: "/" +# Default: "" +# +UseHTTPSLinkForUrl="" + + +# Maximum length of URL part shown on stats page (number of characters). +# This affects only URL visible text, links still work. +# Default: 64 +# +MaxLengthOfShownURL=64 + + +# You can enter HTML code that will be added at the top of AWStats reports. +# Default: "" +# +HTMLHeadSection="" + + +# You can enter HTML code that will be added at the end of AWStats reports. +# Great to add advert ban. +# Default: "" +# +HTMLEndSection="" + + +# By default AWStats page contains meta tag robots=noindex,nofollow +# If you want to have your statistics to be indexed, set this option to 1. +# Default: 0 +# +MetaRobot=0 + + +# You can set Logo and LogoLink to use your own logo. +# Logo must be the name of image file (must be in $DirIcons/other directory). +# LogoLink is the expected URL when clicking on Logo. +# Default: "awstats_logo6.png" +# +Logo="awstats_logo6.png" +LogoLink="http://awstats.sourceforge.net" + + +# Value of maximum bar width/height for horizontal/vertical HTML graphics bars. +# Default: 260/90 +# +BarWidth = 260 +BarHeight = 90 + + +# You can ask AWStats to use a particular CSS (Cascading Style Sheet) to +# change its look. To create a style sheet, you can use samples provided with +# AWStats in wwwroot/css directory. +# Example: "/awstatscss/awstats_bw.css" +# Example: "/css/awstats_bw.css" +# Default: "" +# +StyleSheet="" + + +# Those color parameters can be used (if StyleSheet parameter is not used) +# to change AWStats look. +# Example: color_name="RRGGBB" # RRGGBB is Red Green Blue components in Hex +# +color_Background="FFFFFF" # Background color for main page (Default = "FFFFFF") +color_TableBGTitle="CCCCDD" # Background color for table title (Default = "CCCCDD") +color_TableTitle="000000" # Table title font color (Default = "000000") +color_TableBG="CCCCDD" # Background color for table (Default = "CCCCDD") +color_TableRowTitle="FFFFFF" # Table row title font color (Default = "FFFFFF") +color_TableBGRowTitle="ECECEC" # Background color for row title (Default = "ECECEC") +color_TableBorder="ECECEC" # Table border color (Default = "ECECEC") +color_text="000000" # Color of text (Default = "000000") +color_textpercent="606060" # Color of text for percent values (Default = "606060") +color_titletext="000000" # Color of text title within colored Title Rows (Default = "000000") +color_weekend="EAEAEA" # Color for week-end days (Default = "EAEAEA") +color_link="0011BB" # Color of HTML links (Default = "0011BB") +color_hover="605040" # Color of HTML on-mouseover links (Default = "605040") +color_u="FFAA66" # Background color for number of unique visitors (Default = "FFAA66") +color_v="F4F090" # Background color for number of visites (Default = "F4F090") +color_p="4477DD" # Background color for number of pages (Default = "4477DD") +color_h="66DDEE" # Background color for number of hits (Default = "66DDEE") +color_k="2EA495" # Background color for number of bytes (Default = "2EA495") +color_s="8888DD" # Background color for number of search (Default = "8888DD") +color_e="CEC2E8" # Background color for number of entry pages (Default = "CEC2E8") +color_x="C1B2E2" # Background color for number of exit pages (Default = "C1B2E2") + + + +#----------------------------------------------------------------------------- +# PLUGINS +#----------------------------------------------------------------------------- + +# Add here all plugin files you want to load. +# Plugin files must be .pm files stored in 'plugins' directory. +# Uncomment LoadPlugin lines to enable a plugin after checking that perl +# modules required by the plugin are installed. + +# PLUGIN: Tooltips +# REQUIRED MODULES: None +# PARAMETERS: None +# DESCRIPTION: Add tooltips pop-up help boxes to HTML report pages. +# NOTE: This will increased HTML report pages size, thus server load and bandwidth. +# +#LoadPlugin="tooltips" + +# PLUGIN: DecodeUTFKeys +# REQUIRED MODULES: Encode and URI::Escape +# PARAMETERS: None +# DESCRIPTION: Allow AWStats to show correctly (in language charset) +# keywords/keyphrases strings even if they were UTF8 coded by the +# referer search engine. +# +#LoadPlugin="decodeutfkeys" + +# PLUGIN: IPv6 +# PARAMETERS: None +# REQUIRED MODULES: Net::IP and Net::DNS +# DESCRIPTION: This plugin gives AWStats capability to make reverse DNS +# lookup on IPv6 addresses. +# +#LoadPlugin="ipv6" + +# PLUGIN: HashFiles +# REQUIRED MODULES: Storable +# PARAMETERS: None +# DESCRIPTION: AWStats DNS cache files are read/saved as native hash files. +# This increases DNS cache files loading speed, above all for very large web sites. +# +#LoadPlugin="hashfiles" + + +# PLUGIN: UserInfo +# REQUIRED MODULES: None +# PARAMETERS: None +# DESCRIPTION: Add a text (Firtname, Lastname, Office Department, ...) in +# authenticated user reports for each login value. +# A text file called userinfo.myconfig.txt, with two fields (first is login, +# second is text to show, separated by a tab char) must be created in DirData +# directory. +# +#LoadPlugin="userinfo" + +# PLUGIN: HostInfo +# REQUIRED MODULES: Net::XWhois +# PARAMETERS: None +# DESCRIPTION: Add a column into host chart with a link to open a popup window that shows +# info on host (like whois records). +# +#LoadPlugin="hostinfo" + +# PLUGIN: ClusterInfo +# REQUIRED MODULES: None +# PARAMETERS: None +# DESCRIPTION: Add a text (for example a full hostname) in cluster reports for each cluster +# number. A text file called clusterinfo.myconfig.txt, with two fields (first is +# cluster number, second is text to show) separated by a tab char. must be +# created into DirData directory. +# Note this plugin is useless if ShowClusterStats is set to 0 or if you don't +# use a personalized log format that contains %cluster tag. +# +#LoadPlugin="clusterinfo" + +# PLUGIN: UrlAliases +# REQUIRED MODULES: None +# PARAMETERS: None +# DESCRIPTION: Add a text (Page title, description...) in URL reports before URL value. +# A text file called urlalias.myconfig.txt, with two fields (first is URL, +# second is text to show, separated by a tab char) must be created into +# DirData directory. +# +#LoadPlugin="urlalias" + +# PLUGIN: TimeHiRes +# REQUIRED MODULES: Time::HiRes (if Perl < 5.8) +# PARAMETERS: None +# DESCRIPTION: Time reported by -showsteps option is in millisecond. For debug purpose. +# +#LoadPlugin="timehires" + +# PLUGIN: TimeZone +# REQUIRED MODULES: Time::Local +# PARAMETERS: [timezone offset] +# DESCRIPTION: Allow AWStats to adjust time stamps for a different timezone +# This plugin reduces AWStats speed of 10% !!!!!!! +# LoadPlugin="timezone" +# LoadPlugin="timezone +2" +# LoadPlugin="timezone CET" +# +#LoadPlugin="timezone +2" + +# PLUGIN: Rawlog +# REQUIRED MODULES: None +# PARAMETERS: None +# DESCRIPTION: This plugin adds a form in AWStats main page to allow users to see raw +# content of current log files. A filter is also available. +# +#LoadPlugin="rawlog" + +# PLUGIN: GraphApplet +# REQUIRED MODULES: None +# PARAMETERS: [CSS classes to override] +# DESCRIPTION: Supported charts are built by a 3D graphic applet. +# +#LoadPlugin="graphapplet /awstatsclasses" # EXPERIMENTAL FEATURE + +# PLUGIN: GraphGoogleChartAPI +# REQUIRED MODULES: None +# PARAMETERS: None +# DESCRIPTION: Replaces the standard charts with free Google API generated images +# in HTML reports. If country data is available and more than one country has hits, +# a map will be generated using Google Visualizations. +# Note: The machine where reports are displayed must have Internet access for the +# charts to be generated. The only data sent to Google includes the statistic numbers, +# legend names and country names. +# Warning: This plugin is not compatible with option BuildReportFormat=xhtml. +# +#LoadPlugin="graphgooglechartapi" + +# PLUGIN: GeoIPfree +# REQUIRED MODULES: Geo::IPfree version 0.2+ (from Graciliano M.P.) +# PARAMETERS: None +# DESCRIPTION: Country chart is built from an Internet IP-Country database. +# This plugin is useless for intranet only log files. +# Note: You must choose between using this plugin (need Perl Geo::IPfree +# module, database is free but not up to date) or the GeoIP plugin (need +# Perl Geo::IP module from Maxmind, database is also free and up to date). +# Note: Activestate provide a corrupted version of Geo::IPfree 0.2 Perl +# module, so install it from elsewhere (from www.cpan.org for example). +# This plugin reduces AWStats speed by up to 10% ! +# +#LoadPlugin="geoipfree" + +# MAXMIND GEO IP MODULES: Please see documentation for notes on all Maxmind modules + +# PLUGIN: GeoIP +# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind) +# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/geoip.dat[+/pathto/override.txt]] +# DESCRIPTION: Builds a country chart and adds an entry to the hosts +# table with country name +# Replace spaces in the path of geoip data file with string "%20". +# +#LoadPlugin="geoip GEOIP_STANDARD /pathto/GeoIP.dat" +LoadPlugin="geoip GEOIP_STANDARD /usr/share/GeoIP/GeoIP.dat" + +# PLUGIN: GeoIP_City_Maxmind +# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind) +# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPCity.dat[+/pathto/override.txt]] +# DESCRIPTION: This plugin adds a column under the hosts field and tracks the pageviews +# and hits by city including regions. +# Replace spaces in the path of geoip data file with string "%20". +# +#LoadPlugin="geoip_city_maxmind GEOIP_STANDARD /pathto/GeoIPCity.dat" + +# PLUGIN: GeoIP_ASN_Maxmind +# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind) +# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPASN.dat[+/pathto/override.txt][+http://linktoASlookup]] +# DESCRIPTION: This plugin adds a chart of AS numbers where the host IP address is registered. +# This plugin can display some ISP information if included in the database. You can also provide +# a link that will be used to lookup additional registration data. Put the link at the end of +# the parameter string and the report page will include the link with the full AS number at the end. +# Replace spaces in the path of geoip data file with string "%20". +# +#LoadPlugin="geoip_asn_maxmind GEOIP_STANDARD /usr/local/geoip.dat+http://enc.com.au/itools/aut-num.php?autnum=" + +# PLUGIN: GeoIP_Region_Maxmind +# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind) +# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPRegion.dat[+/pathto/override.txt]] +# DESCRIPTION:This plugin adds a chart of hits by regions. Only regions for US and +# Canada can be detected. +# Replace spaces in the path of geoip data file with string "%20". +# +#LoadPlugin="geoip_region_maxmind GEOIP_STANDARD /pathto/GeoIPRegion.dat" + +# PLUGIN: GeoIP_ISP_Maxmind +# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind) +# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPISP.dat[+/pathto/override.txt]] +# DESCRIPTION: This plugin adds a chart of hits by ISP. +# Replace spaces in the path of geoip data file with string "%20". +# +#LoadPlugin="geoip_isp_maxmind GEOIP_STANDARD /pathto/GeoIPISP.dat" + +# PLUGIN: GeoIP_Org_Maxmind +# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind) +# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPOrg.dat[+/pathto/override.txt]] +# DESCRIPTION: This plugin add a chart of hits by Organization name +# Replace spaces in the path of geoip data file with string "%20". +# +#LoadPlugin="geoip_org_maxmind GEOIP_STANDARD /pathto/GeoIPOrg.dat" + + +#----------------------------------------------------------------------------- +# EXTRA SECTIONS +#----------------------------------------------------------------------------- + +# You can define your own charts, you choose here what are rows and columns +# keys. This feature is particularly useful for marketing purpose, tracking +# products orders for example. +# For this, edit all parameters of Extra section. Each set of parameter is a +# different chart. For several charts, duplicate section changing the number. +# Note: Each Extra section reduces AWStats speed by 8%. +# +# WARNING: A wrong setup of Extra section might result in too large arrays +# that will consume all your memory, making AWStats unusable after several +# updates, so be sure to setup it correctly. +# In most cases, you don't need this feature. +# +# ExtraSectionNameX is title of your personalized chart. +# ExtraSectionCodeFilterX is list of codes the record code field must match. +# Put an empty string for no test on code. +# ExtraSectionConditionX are conditions you can use to count or not the hit, +# Use one of the field condition +# (URL,URLWITHQUERY,QUERY_STRING,REFERER,UA,HOSTINLOG,HOST,VHOST,extraX) +# and a regex to match, after a coma. Use "||" for "OR". +# ExtraSectionFirstColumnTitleX is the first column title of the chart. +# ExtraSectionFirstColumnValuesX is a string to tell AWStats which field to +# extract value from +# (URL,URLWITHQUERY,QUERY_STRING,REFERER,UA,HOSTINLOG,HOST,VHOST,extraX) +# and how to extract the value (using regex syntax). Each different value +# found will appear in first column of report on a different row. Be sure +# that list of different possible values will not grow indefinitely. +# ExtraSectionFirstColumnFormatX is the string used to write value. +# ExtraSectionStatTypesX are things you want to count. You can use standard +# code letters (P for pages,H for hits,B for bandwidth,L for last access). +# ExtraSectionAddAverageRowX add a row at bottom of chart with average values. +# ExtraSectionAddSumRowX add a row at bottom of chart with sum values. +# MaxNbOfExtraX is maximum number of rows shown in chart. +# MinHitExtraX is minimum number of hits required to be shown in chart. +# + +# Example to report the 20 products the most ordered by "order.cgi" script +#ExtraSectionName1="Product orders" +#ExtraSectionCodeFilter1="200 304" +#ExtraSectionCondition1="URL,\/cgi\-bin\/order\.cgi||URL,\/cgi\-bin\/order2\.cgi" +#ExtraSectionFirstColumnTitle1="Product ID" +#ExtraSectionFirstColumnValues1="QUERY_STRING,productid=([^&]+)" +#ExtraSectionFirstColumnFormat1="%s" +#ExtraSectionStatTypes1=PL +#ExtraSectionAddAverageRow1=0 +#ExtraSectionAddSumRow1=1 +#MaxNbOfExtra1=20 +#MinHitExtra1=1 + +# Report domain aliases based on virtual host name (Apache %v) collected by %extra1 in the LogFormat directive: +ExtraSectionName1="Domains aliases" +ExtraSectionCodeFilter1="200 304" +ExtraSectionCondition1="" +ExtraSectionFirstColumnTitle1="Domain alias" +ExtraSectionFirstColumnValues1="extra1,([^&]+)" +ExtraSectionFirstColumnFormat1="%s" +ExtraSectionStatTypes1=UVHL +ExtraSectionAddAverageRow1=0 +ExtraSectionAddSumRow1=1 +MaxNbOfExtra1=20 +MinHitExtra1=1 + + +# There is also a global parameter ExtraTrackedRowsLimit that limits the +# number of possible rows an ExtraSection can report. This parameter is +# here to protect too much memory use when you make a bad setup in your +# ExtraSection. It applies to all ExtraSection independently meaning that +# none ExtraSection can report more rows than value defined by ExtraTrackedRowsLimit. +# If you know an ExtraSection will report more rows than its value, you should +# increase this parameter or AWStats will stop with an error. +# Example: 2000 +# Default: 500 +# +ExtraTrackedRowsLimit=500 + + +#----------------------------------------------------------------------------- +# INCLUDES +#----------------------------------------------------------------------------- + +# You can include other config files using the directive with the name of the +# config file. +# This is particularly useful for users who have a lot of virtual servers, so +# a lot of config files and want to maintain common values in only one file. +# Note that when a variable is defined both in a config file and in an +# included file, AWStats will use the last value read for parameters that +# contains one value and AWStats will concat all values from both files for +# parameters that are lists of values. +# + +#Include "" + diff --git a/configuration/environments_scripts/central_reverse_proxy/files/home/wiki/app.rb b/configuration/environments_scripts/central_reverse_proxy/files/home/wiki/app.rb index 9161333c52b..0b61c2df0a7 100644 --- a/configuration/environments_scripts/central_reverse_proxy/files/home/wiki/app.rb +++ b/configuration/environments_scripts/central_reverse_proxy/files/home/wiki/app.rb @@ -17,7 +17,6 @@ class App < Precious::App helpers do def authenticate! - puts "authentication" public_urls=IO.readlines 'public.txt' public_urls.each {|url| if self.env['PATH_INFO'] == url.slice(0, url.length-1) @@ -27,7 +26,6 @@ class App < Precious::App if self.env['PATH_INFO'].start_with?('/wiki/images') || self.env['PATH_INFO'].start_with?('/favicon.ico') - puts "Allowing " + self.env['PATH_INFO'] return end } @@ -35,7 +33,6 @@ class App < Precious::App return end @_auth = Rack::Auth::Basic::Request.new(request.env) - puts "here" if self.env['PATH_INFO'].split('/').length >=2 && (self.env['PATH_INFO'].split('/')[1] != 'wiki' && self.env['PATH_INFO'].split('/')[2] != 'wiki' && @@ -43,16 +40,16 @@ class App < Precious::App self.env['PATH_INFO'].split('/')[2] != 'home' && self.env['PATH_INFO'].split('/')[1] != 'Home' && self.env['PATH_INFO'].split('/')[2] != 'Home' && + self.env['PATH_INFO'].split('/')[1] != 'Home.md' && self.env['PATH_INFO'].split('/')[1] != 'search' && self.env['PATH_INFO'].split('/')[2] != 'search' && self.env['PATH_INFO'].split('/')[1] != 'edit' && self.env['PATH_INFO'].split('/')[2] != 'edit' && self.env['PATH_INFO'].split('/')[1] != 'preview' && - self.env['PATH_INFO'].split('/')[2] != 'preview') + self.env['PATH_INFO'].split('/')[2] != 'preview' && + (self.env['PATH_INFO'].split('/')[1] != 'gollum'|| self.env['PATH_INFO'].split('/')[2] != 'create')) throw(:halt, [403, 'Forbidden - You can not access anything outside wiki/ path.']) end - puts settings - puts settings.authorized_users if @_auth.provided? end if @_auth.provided? && @_auth.basic? && @_auth.credentials && @user = detected_user(@_auth.credentials) @@ -69,7 +66,6 @@ class App < Precious::App end def users - puts settings @_users ||= settings.authorized_users.map {|u| User.new(*u) } end diff --git a/configuration/environments_scripts/central_reverse_proxy/files/usr/share/bugzilla/data/params.json b/configuration/environments_scripts/central_reverse_proxy/files/usr/share/bugzilla/data/params.json new file mode 100644 index 00000000000..6ac423d1d33 --- /dev/null +++ b/configuration/environments_scripts/central_reverse_proxy/files/usr/share/bugzilla/data/params.json @@ -0,0 +1,104 @@ +{ + "LDAPBaseDN" : "", + "LDAPbinddn" : "", + "LDAPfilter" : "", + "LDAPmailattribute" : "mail", + "LDAPserver" : "", + "LDAPstarttls" : "0", + "LDAPuidattribute" : "uid", + "RADIUS_NAS_IP" : "", + "RADIUS_email_suffix" : "", + "RADIUS_secret" : "", + "RADIUS_server" : "", + "ajax_user_autocompletion" : "1", + "allow_attachment_deletion" : "0", + "allow_attachment_display" : "0", + "allowbugdeletion" : "0", + "allowemailchange" : "1", + "allowuserdeletion" : "0", + "announcehtml" : "", + "attachment_base" : "", + "auth_env_email" : "", + "auth_env_id" : "", + "auth_env_realname" : "", + "chartgroup" : "editbugs", + "collapsed_comment_tags" : "obsolete, spam", + "comment_taggers_group" : "editbugs", + "commentonchange_resolution" : "0", + "commentonduplicate" : "0", + "confirmuniqueusermatch" : "1", + "cookiedomain" : "", + "cookiepath" : "/", + "createemailregexp" : ".*", + "debug_group" : "admin", + "default_search_limit" : "500", + "defaultopsys" : "", + "defaultplatform" : "", + "defaultpriority" : "P5", + "defaultquery" : "resolution=---&emailassigned_to1=1&emailassigned_to2=1&emailreporter2=1&emailcc2=1&emailqa_contact2=1&emaillongdesc3=1&order=Importance&long_desc_type=substring", + "defaultseverity" : "enhancement", + "duplicate_or_move_bug_status" : "RESOLVED", + "emailregexp" : "^[\\w\\.\\+\\-=']+@[\\w\\.\\-]+\\.[\\w\\-]+$", + "emailregexpdesc" : "A legal address must contain exactly one '@', and at least one '.' after the @.", + "emailsuffix" : "", + "font_file" : "", + "globalwatchers" : "", + "inbound_proxies" : "", + "insidergroup" : "", + "last_visit_keep_days" : "10", + "letsubmitterchoosemilestone" : "1", + "letsubmitterchoosepriority" : "1", + "mail_delivery_method" : "SMTP", + "mailfrom" : "bugzilla-daemon@sapsailing.com", + "maintainer" : "", + "makeproductgroups" : "0", + "max_search_results" : "10000", + "maxattachmentsize" : "1024", + "maxlocalattachment" : "0", + "maxusermatches" : "1000", + "memcached_namespace" : "bugzilla:", + "memcached_servers" : "", + "musthavemilestoneonaccept" : "0", + "mybugstemplate" : "buglist.cgi?resolution=---&emailassigned_to1=1&emailreporter1=1&emailtype1=exact&email1=%userid%", + "noresolveonopenblockers" : "0", + "or_groups" : "1", + "password_check_on_login" : "1", + "password_complexity" : "no_constraints", + "proxy_url" : "", + "querysharegroup" : "editbugs", + "quip_list_entry_control" : "open", + "rememberlogin" : "on", + "requirelogin" : "1", + "search_allow_no_criteria" : "1", + "shadowdb" : "", + "shadowdbhost" : "", + "shadowdbport" : "3306", + "shadowdbsock" : "", + "shutdownhtml" : "", + "smtp_debug" : "1", + "smtp_password" : "AkoTN6Upot/Sgc/JJD1VRUbqsM15eQ/5paY4FB/YkEkU", + "smtp_ssl" : "1", + "smtp_username" : "AKIAIHCQEFAZDLIK7SUQ", + "smtpserver" : "email-smtp.eu-west-1.amazonaws.com", + "ssl_redirect" : "0", + "sslbase" : "https://bugzilla.sapsailing.com/bugzilla/", + "strict_isolation" : "0", + "strict_transport_security" : "off", + "timetrackinggroup" : "editbugs", + "upgrade_notification" : "latest_stable_release", + "urlbase" : "https://bugzilla.sapsailing.com/bugzilla/", + "use_mailer_queue" : "0", + "use_see_also" : "1", + "useclassification" : "0", + "usemenuforusers" : "0", + "useqacontact" : "0", + "user_info_class" : "CGI", + "user_verify_class" : "DB", + "usestatuswhiteboard" : "0", + "usetargetmilestone" : "0", + "usevisibilitygroups" : "0", + "utf8" : "1", + "webdotbase" : "", + "webservice_email_filter" : "0", + "whinedays" : "7" +} diff --git a/configuration/environments_scripts/central_reverse_proxy/files/var/www/cgi-bin/github.cgi b/configuration/environments_scripts/central_reverse_proxy/files/var/www/cgi-bin/github.cgi index 75a7a891e7f..4ba836711d5 100755 --- a/configuration/environments_scripts/central_reverse_proxy/files/var/www/cgi-bin/github.cgi +++ b/configuration/environments_scripts/central_reverse_proxy/files/var/www/cgi-bin/github.cgi @@ -5,15 +5,19 @@ BODY=$( cat ) echo "${BODY}" >/tmp/github-hook-body REF=$( echo "${BODY}" | jq -r '.ref' ) PUSHER=$( echo "${BODY}" | jq -r '.pusher.email' ) -logger -t github-cgi "ref ia $REF, pusher was $PUSHER" +logger -t github-cgi "ref is $REF, pusher was $PUSHER" # For testing: #if [ "${PUSHER}" = "axel.uhl@sap.com" -a "${REF}" = "refs/heads/translation" ]; then -if [ "${PUSHER}" = "tmsatsls+github.tools.sap_service-tip-git@sap.com" -a "${REF}" = "refs/heads/translation" ]; then +tmsatsls+github.com_service-tip-git@sap.com +# The filter in case this is to be used for github.tools.sap: +#if [ "${PUSHER}" = "tmsatsls+github.tools.sap_service-tip-git@sap.com" -a "${REF}" = "refs/heads/translation" ]; then +# The filter for github.com: +if [ "${PUSHER}" = "tmsatsls+github.com_service-tip-git@sap.com" -a "${REF}" = "refs/heads/translation" ]; then echo "Identified a push to refs/heads/translation by ${PUSHER}." echo "Fetching translation branch from github.tools.sap and pushing it to ssh://trac@sapsailing.com/home/trac/git" logger -t github-cgi "fetching translation branch from github.tools.sap and pushing it to ssh://trac@sapsailing.com/home/trac/git" cd /home/wiki/gitwiki - sudo -u wiki git fetch sapsailing translation:translation 2>&1 + sudo -u wiki git fetch github translation:translation 2>&1 sudo -u wiki git push origin translation:translation 2>&1 else echo "Either pusher was not tmsatsls+github.tools.sap_service-tip-git@sap.com or ref was not refs/heads/translation. Not triggering." diff --git a/configuration/environments_scripts/central_reverse_proxy/setup-central-reverse-proxy-part-2.sh b/configuration/environments_scripts/central_reverse_proxy/setup-central-reverse-proxy-part-2.sh index 34de879425a..95573600883 100755 --- a/configuration/environments_scripts/central_reverse_proxy/setup-central-reverse-proxy-part-2.sh +++ b/configuration/environments_scripts/central_reverse_proxy/setup-central-reverse-proxy-part-2.sh @@ -11,6 +11,10 @@ # where {image-type} identifies the "environment" from configuration/environments_scripts # which usually would be "central_reverse_proxy" here, passed in from the previous stage's # script. +if [[ "$#" -ne 2 ]]; then + echo "2 arguments required. Check comment of scripts for more details." + exit 2 +fi IP=$1 IMAGE_TYPE="$2" GIT_COPY_USER="wiki" @@ -18,28 +22,42 @@ RELATIVE_PATH_TO_GIT="gitwiki" # the relative path to the repo within the git_co TEMPORARY_HOME_COPY_LOCATION="/root/temporary_home_copy" # home nested within this. ssh -A "root@${IP}" "bash -s" << EOF sudo systemctl start crond.service +sudo systemctl start tmux-management-panel.service . imageupgrade_functions.sh cp -r "$TEMPORARY_HOME_COPY_LOCATION"/home / rm -rf "$TEMPORARY_HOME_COPY_LOCATION" -build_crontab_and_setup_files -f "${IMAGE_TYPE}" "${GIT_COPY_USER}" "${RELATIVE_PATH_TO_GIT}" # files have already been copied so -f is used. +# Localhost works here as we are logged on as root and are using ssh agent forwarding. +if ! build_crontab_and_setup_files -h localhost -f "${IMAGE_TYPE}" "${GIT_COPY_USER}" "${RELATIVE_PATH_TO_GIT}"; then # files have already been copied so -f is used. + exit 1 +fi +setup_keys -p "${IMAGE_TYPE}" chown trac:static /var/www/static # setup nfs systemctl enable nfs-server echo "/var/log/old 172.31.0.0/16(rw,nohide,no_root_squash) /home/scores 172.31.0.0/16(rw,nohide,no_root_squash)" >>/etc/exports systemctl start nfs-server -# scp -p -o StrictHostKeyChecking=no -r root@sapsailing.com:/etc/ssh /etc # causes some issue with MACs +scp -p -o StrictHostKeyChecking=no -r root@sapsailing.com:/etc/ssh /etc # append hostname to sysconfig echo "HOSTNAME=sapsailing.com" >> /etc/sysconfig/network sed -i "s/\(127.0.0.1 *\)/\1 sapsailing.com /" /etc/hosts hostname sapsailing.com hostnamectl set-hostname sapsailing.com +if sshd -t; then + systemctl restart sshd +fi EOF -ssh -A -f root@"$IP" "cd /var/log/old/cache/docker/registry && nohup docker-compose up &>/dev/null &" &> /dev/null -echo "Please now run the script target-group-tag-route53-nfs-elasticIP-setup.sh which configures the EC2 instance tags, adds to the " +ssh -o StrictHostKeyChecking=no -A -f root@"$IP" "cd /var/log/old/cache/docker/registry && nohup docker-compose up &>/dev/null &" &> /dev/null +echo "PLEASE READ ALL OF THE FOLLOWING..." +echo "Remove the existing central reverse proxy from the SSH target groups." +echo "When ready, press a key to continue, which will run the script target-group-tag-route53-nfs-elasticIP-setup.sh." +echo "This configures the EC2 instance tags, adds to the " echo "necessary target groups, modifies a few records in route53 (logs.internal.sapsailing.com" -echo "and smtp.internal.sapsailing.com), remounts those dependent on this, and sets the elastic IP." -echo "You will need to have the aws cli installed and have the necessary permissions to make these alterations manually." -echo "In particular, make sure you have an active session token in your shell's environment, e.g., obtained" -echo "through the awsmfalogon.sh script." -echo "Have a great day!" +echo "and smtp.internal.sapsailing.com), remounts those instances that are dependent on this, and sets the elastic IP." +echo "You will need to have the AWS CLI installed and have credentials that allow you to run all the commands in the script." +echo "Make sure you have an active session token in your shell's environment, e.g., obtained" +echo "through the awsmfalogon.sh script. The script requires that you have jq and host installed locally." +echo "If you haven't already authenticated, then stop this script; authenticate manually;" +echo "and then run the script named above with the remote IP as a parameter." +read -n 1 -p "Press a key to continue" key_pressed +"$(dirname $0)"/target-group-tag-route53-nfs-elasticIP-setup.sh \ No newline at end of file diff --git a/configuration/environments_scripts/central_reverse_proxy/setup-central-reverse-proxy.sh b/configuration/environments_scripts/central_reverse_proxy/setup-central-reverse-proxy.sh index 6ac7b73de42..eca23424959 100755 --- a/configuration/environments_scripts/central_reverse_proxy/setup-central-reverse-proxy.sh +++ b/configuration/environments_scripts/central_reverse_proxy/setup-central-reverse-proxy.sh @@ -4,9 +4,10 @@ # provides the Git repository, runs Bugzilla and Gollum for wiki access, # furthermore AWStats, goaccess and apachetop support within a tmux session, # releases.sapsailing.com, jobs.sapsailing.com content, and a Docker -# infrastructure for a self-hosted Docker image registry. +# infrastructure for a self-hosted Docker image registry. It assumes the +# existence of a running webserver accessible under sapsailing.com. # -# Start by launching a new instance, e.g., of type m3.xlarge, in the same AZ +# Start by launching a new instance, e.g., of type t3.xlarge, in the same AZ # as the current Webserver / Central Reverse Proxy. This will become important # as you will need to detach volumes from the latter to attach them to the # new instance. @@ -25,9 +26,18 @@ # This will do all necessary set-up up to the point where the large volumes # currently attached to and mounted on the current Central Reverse Proxy will # need to be unmounted, detached, attached to the new instance, and mounted there. +terminationCheck() { + # $1 status returned by the last command. + # Exits the program if the passed argument is non zero. + # Used to ensure the program doesn't continue if a major error occurs. + [[ "$1" -eq 0 ]] || { echo "Non-zero exit code. Exiting to avoid damage" && exit 1; } +} if [[ "$#" -ne 4 ]]; then - echo "IP and bearer token required. Please check comment description for further details." + echo "4 arguments required. Please check comment description for further details." + echo "Example usage: setup-central-reverse-proxy.sh 1.2.3.4 0OcJ1938QE5it875kjlQe7HnzQ6740jsnMEVzowjZrs= 18.170.25.225 /home/sailing/code" + exit 2 fi +echo "Make sure the instance is in the same AZ as the existing reverse proxy, so the volumes can be switched over." IP=$1 BEARER_TOKEN=$2 IMAGEUPGRADE_FUNCTIONS_IP="$3" # can be a domain name, such as sapsailing.com @@ -36,7 +46,7 @@ IMAGE_TYPE="central_reverse_proxy" HTTP_LOGROTATE_ABSOLUTE=/etc/logrotate.d/httpd GIT_COPY_USER="wiki" RELATIVE_PATH_TO_GIT="gitwiki" # the relative path to the repo within the git_copy_user -# The aws credentials will have to be manually installed in the aws user. +# This authorized keys copying is essential as we rely on the ability to log into the root user. ssh -A "ec2-user@${IP}" "bash -s" << FIRSTEOF # Correct authorized keys. May not be necessary if update_authorized_keys is running. sudo su - -c "cat ~ec2-user/.ssh/authorized_keys > /root/.ssh/authorized_keys" @@ -48,7 +58,7 @@ yum update -y yum install -y httpd mod_proxy_html tmux nfs-utils git whois jq cronie iptables mailx nmap icu mariadb105-server tree #icu is a c/c++ library that provides unicode and globalisation support for software development. # docker setup yum install -y docker -sudo curl -L "https://github.com/docker/compose/releases/download/v2.26.1/docker-compose-\$(uname -s)-\$(uname -m)" -o /usr/local/bin/docker-compose +sudo curl --silent -L "https://github.com/docker/compose/releases/download/v2.26.1/docker-compose-\$(uname -s)-\$(uname -m)" -o /usr/local/bin/docker-compose chmod +x /usr/local/bin/docker-compose yum install -y perl perl-CGI perl-Template-Toolkit perl-CPAN perl-DBD-MySQL mod_perl perl-GD gcc-c++ # ruby and gollum for wiki @@ -57,28 +67,6 @@ yum install -y ruby ruby-devel libicu libicu-devel zlib zlib-devel git cmake ope gem install gollum -v 5.3.2 gem update --system 3.5.7 cd /home -# The following line is for production use: -scp -o StrictHostKeyChecking=no -p root@"$IMAGEUPGRADE_FUNCTIONS_IP":"$IMAGEUPGRADE_FUNCTIONS_PATH_ON_INSTANCE_TO_GIT"/configuration/environments_scripts/repo/usr/local/bin/imageupgrade_functions.sh /usr/local/bin -# The following line is for test use, copying from a test instance with a check-out Git workspace: -# scp -o StrictHostKeyChecking=no -p "root@13.40.100.54:/home/sailing/code/configuration/environments_scripts/repo/usr/local/bin/imageupgrade_functions.sh" /usr/local/bin -. imageupgrade_functions.sh -setup_cloud_cfg_and_root_login -# setup files -build_crontab_and_setup_files -c -n "${IMAGE_TYPE}" "${GIT_COPY_USER}" "${RELATIVE_PATH_TO_GIT}" # -c & -n mean only files are copied over. -setup_swap 5000 -cd /home -for folder in * ; do - [[ -d "\$folder" ]] || continue - grep "\$folder" /etc/passwd || continue - chown -R "\$folder":"\$folder" "\$folder" -done -# setup mail -setup_mail_sending -# setup sshd config -setup_sshd_resilience -# setup goaccess and apachetop -setup_apachetop -setup_goaccess # copy bugzilla scp -o StrictHostKeyChecking=no root@sapsailing.com:/var/www/static/bugzilla-5.0.4.tar.gz /usr/local/src cd /usr/local/src @@ -87,9 +75,11 @@ mv bugzilla-5.0.4 /usr/share/bugzilla cd /usr/share/bugzilla/ scp -o StrictHostKeyChecking=no root@sapsailing.com:/usr/share/bugzilla/localconfig . echo "Bugzilla has been copied. Now setting up bugzilla modules." -echo "This can take 5 minutes or so. The output is muted to prevent excessive warnings and clutter." +echo "This can take 5 minutes or so. The output is muted (but sent to log.txt) to prevent excessive warnings and clutter in the terminal." SECONDEOF -ssh -A "root@${IP}" "bash -s" << BUGZILLAEOF &>/dev/null +terminationCheck "$?" +ssh -A "root@${IP}" "bash -s" << BUGZILLAEOF &>log.txt +cd /usr/share/bugzilla/ # essentials bugzilla /usr/bin/perl install-module.pl DateTime /usr/bin/perl install-module.pl DateTime::TimeZone @@ -119,29 +109,57 @@ ssh -A "root@${IP}" "bash -s" << BUGZILLAEOF &>/dev/null /usr/bin/perl install-module.pl Daemon::Generic /usr/bin/perl install-module.pl File::MimeInfo::Magic /usr/bin/perl install-module.pl File::Copy::Recursive -scp -p root@sapsailing.com:/usr/share/bugzilla/data/params.json /usr/share/bugzilla/data/params.json +/usr/bin/perl install-module.pl MIME::Base64 +/usr/bin/perl install-module.pl Authen::SASL BUGZILLAEOF +terminationCheck "$?" read -n 1 -p "Bugzilla installation complete, when ready press a key to continue." key_pressed # use the localconfig file to setup the bugzilla # t forces tty allocation. ssh root@"${IP}" -A -t 'cd /usr/share/bugzilla/; ./checksetup.pl' -ssh -A "root@${IP}" "cpan install Geo::IP" +terminationCheck "$?" +ssh -A -t "root@${IP}" "cpan install Geo::IP" +terminationCheck "$?" ssh -A "root@${IP}" "bash -s" << THIRDEOF +# The following line is for production use: +scp -o StrictHostKeyChecking=no -p root@"$IMAGEUPGRADE_FUNCTIONS_IP":"$IMAGEUPGRADE_FUNCTIONS_PATH_ON_INSTANCE_TO_GIT"/configuration/environments_scripts/repo/usr/local/bin/imageupgrade_functions.sh /usr/local/bin +# The following line is for test use, copying from a test instance with a check-out Git workspace: +# scp -o StrictHostKeyChecking=no -p "root@13.40.100.54:/home/sailing/code/configuration/environments_scripts/repo/usr/local/bin/imageupgrade_functions.sh" /usr/local/bin . imageupgrade_functions.sh +setup_cloud_cfg_and_root_login +# setup files +if ! build_crontab_and_setup_files -c -n "${IMAGE_TYPE}" "${GIT_COPY_USER}" "${RELATIVE_PATH_TO_GIT}"; then # -c & -n mean only files are copied over. + exit 1 +fi +setup_swap 5000 +cd /home +for folder in * ; do + [[ -d "\$folder" ]] || continue + grep "\$folder" /etc/passwd || continue + chown -R "\$folder":"\$folder" "\$folder" +done +# setup mail +setup_mail_sending +# setup sshd config +setup_sshd_resilience +# setup goaccess and apachetop +setup_apachetop +setup_goaccess echo $BEARER_TOKEN > /root/ssh-key-reader.token # awstats - depends on some of the previous perl modules. -scp -o StrictHostKeyChecking=no -r root@sapsailing.com:/usr/share/GeoIP /usr/share/GeoIP +scp -o StrictHostKeyChecking=no -r root@sapsailing.com:/usr/share/GeoIP /usr/share/GeoIP cd /usr/local/src wget http://prdownloads.sourceforge.net/awstats/awstats-7.0.tar.gz tar -zvxf awstats-7.0.tar.gz mv awstats-7.0/ /usr/share/awstats mkdir /var/lib/awstats -scp -o StrictHostKeyChecking=no -r root@sapsailing.com:/etc/awstats /etc/awstats +# Copies the database for awstats over. +scp -o StrictHostKeyChecking=no -r root@sapsailing.com:/var/lib/awstats /var/lib chmod 755 /root cd ~ # Copies across the key vault and other relevant secrets from the existing -# Central Reverse Proxy's /root folder: -rsync -a root@sapsailing.com:/root/{dev-secrets,github_tools_sap.pat,hudson-aws-credentials,key_vault,mail.properties,new_version_key_vault,secrets,ssh-key-reader.token} /root +# central reverse proxy's /root folder: +rsync -a root@sapsailing.com:/root/{dev-secrets,github_tools_sap.pat,hudson-aws-credentials,key_vault,mail.properties,secrets,ssh-key-reader.token} /root scp -o StrictHostKeyChecking=no -r root@sapsailing.com:/etc/letsencrypt /etc # add basic test page which won't cause redirect error code if used as a health check. cat < /var/www/html/index.html @@ -150,12 +168,12 @@ EOF echo "net.ipv4.ip_conntrac_max = 131072" >> /etc/sysctl.conf # setup fail2ban setup_fail2ban -setup_keys "${IMAGE_TYPE}" # setup logrotate.d/httpd # echo "Patching $HTTP_LOGROTATE_ABSOLUTE so that old logs go to /var/log/old/$IP" >>/var/log/sailing.out # mkdir --parents "/var/log/old/REVERSE_PROXIES/${IP}" -# sed -i "s|/var/log/old|/var/log/old/REVERSE_PROXIES/${IP}|" $HTTP_LOGROTATE_ABSOLUTE +# sed -i "s|/var/log/old|/var/log/old/REVERSE_PROXIES/${IP}|" $HTTP_LOGROTATE_ABSOLUTE # logrotate.conf setup +mkdir /var/log/logrotate-target sed -i 's/rotate 4/rotate 20 \n\nolddir \/var\/log\/logrotate-target/' /etc/logrotate.conf sed -i "s/^#compress/compress/" /etc/logrotate.conf # setup httpd git @@ -174,20 +192,24 @@ sudo systemctl enable postfix sudo systemctl restart postfix mkdir --parents /root/temporary_home_copy/home mv /home/* /root/temporary_home_copy/home +scp -o StrictHostKeyChecking=no -r root@sapsailing.com:/var/www/icons /var/www +scp -o StrictHostKeyChecking=no -r root@sapsailing.com:/var/www/errorpages /var/www +scp -o StrictHostKeyChecking=no -r root@sapsailing.com:/var/www/error /var/www echo "UUID=23d42c52-85ee-4f6d-bdfe-c62f69bb689f /home ext4 defaults,noatime,commit=30 0 0 UUID=0b15f5cb-fd3e-48e6-8195-be248cd7726d /var/www/static ext3 defaults,noatime,commit=30 0 0 UUID=ff598428-d380-4429-a690-3809157506b7 /var/log/old ext3 defaults,noatime,commit=30 0 0 UUID=d371e530-c189-4012-ae57-45d67a690554 /var/log/old/cache ext4 defaults,noatime,commit=30 0 0" >>/etc/fstab systemctl enable --now docker THIRDEOF - +terminationCheck "$?" echo "" echo "" -echo "Your turn! READ CAREFULLY! The instance is now prepared." -echo "Please remove the existing central reverse proxy from all target groups tagged with \"CentralReverseProxy\"" -echo "or \"allReverseProxies\" (draining can take 5 mins)." -echo "Also ensure there is at least 1 healthy disposable in the SAME availability zone as the archive," +echo "Your turn! READ CAREFULLY BEFORE ACTING! The instance is now prepared." +echo "Ensure that there is at least 1 healthy disposable in the SAME availability zone as the archive," echo "so there is no risk of all the targets being briefly unhealthy." +echo "Please remove the existing central reverse proxy from all target groups tagged with \"CentralReverseProxy\"" +echo "or \"allReverseProxies\" (draining can take 5 mins), this includes removing the private IP target from the NLB target group." +echo "But do not edit the SSH target group, otherwise the next part will fail." echo "Then unmount the volumes /home, /var/www/static, /var/log/old and /var/log/old/cache from the existing reverse proxy," echo "detach, reattach to the new instance and remount as follows:" echo "First unmount, on the old instance, via" @@ -195,7 +217,7 @@ echo " umount -l -f " echo "Then begin detaching and attaching. This can be done in the AWS EC2 console by going to the old webserver" echo "and clicking on the volumes in question (found within the storage tab)." echo "Then click Detach from within the Actions dropdrown. Reattach to the new instance by clicking Attach from the Actions dropdown," -echo "then choose the new instance and the device name." +echo "then choose the new instance and the device name (which can be any value, because the mounting is done via UUID)." echo "On the new instance itself, the remounting can be done with" echo " mount -a" echo "as /etc/fstab contains all the mount details." diff --git a/configuration/environments_scripts/central_reverse_proxy/target-group-tag-route53-nfs-elasticIP-setup.sh b/configuration/environments_scripts/central_reverse_proxy/target-group-tag-route53-nfs-elasticIP-setup.sh index 1ade30928a8..631af9669b4 100755 --- a/configuration/environments_scripts/central_reverse_proxy/target-group-tag-route53-nfs-elasticIP-setup.sh +++ b/configuration/environments_scripts/central_reverse_proxy/target-group-tag-route53-nfs-elasticIP-setup.sh @@ -9,10 +9,15 @@ if [[ "$#" -ne 1 ]]; then exit 2 fi target_groups=$(aws elbv2 describe-target-groups) -LOCAL_IPV4=$(ssh root@"$1" "ec2-metadata --local-ipv4 | sed \"s/local-ipv4: *//\"") -INSTANCE_ID=$(ssh root@"$1" "ec2-metadata --instance-id | sed \"s/instance-id: *//\"") +LOCAL_IPV4=$(ssh -o StrictHostKeyChecking=false root@"$1" "ec2-metadata --local-ipv4 2>/dev/null | sed \"s/local-ipv4: *//\"") +INSTANCE_ID=$(ssh -o StrictHostKeyChecking=false root@"$1" "ec2-metadata --instance-id 2>/dev/null | sed \"s/instance-id: *//\"") +if [[ -z "$LOCAL_IPV4" || -z "$INSTANCE_ID" ]]; then + echo "Null local IP or Instance ID" + exit 1 +fi ELASTIC_IP="54.229.94.254" -TAGS=("allReverseProxies" "CentralReverseProxy") +INSTANCE_TAGS=("CentralReverseProxy" "ReverseProxy") +TARGET_GROUP_TAGS=("allReverseProxies" "CentralReverseProxy") extract_public_ip() { jq -r ' .Instances | .[] | .PublicIpAddress' | grep -v null } @@ -22,40 +27,58 @@ select_instances_by_tag() { } cd $(dirname "$0") # give the instance the necessary tags. -for tag in "${TAGS[@]}"; do +for tag in "${INSTANCE_TAGS[@]}"; do aws ec2 create-tags --resources "$INSTANCE_ID" --tags Key="$tag",Value="" done # The nlb is the exception case as we use the load balancer arn to further identify it. -nlbArn=$(aws elbv2 describe-tags --resource-arns $(echo "$target_groups" | jq -r '.TargetGroups | .[] | select(.LoadBalancerArns | .[] | contains("loadbalancer/net") ) | .TargetGroupArn') | jq -r '.TagDescriptions | .[] | select(.Tags | any(.Key=="allReverseProxies") ) | .ResourceArn') +ip_based_target_groups_tags=$(aws elbv2 describe-tags --resource-arns $(echo "$target_groups" | jq -r '.TargetGroups | .[] | select(.LoadBalancerArns | any(contains("loadbalancer/net")) ) | .TargetGroupArn')) +nlb_target_group_arn=$(echo "$ip_based_target_groups_tags" | jq -r '.TagDescriptions | .[] | select(.Tags | any(.Key=="allReverseProxies") ) | .ResourceArn') echo "Registering with nlb" -aws elbv2 register-targets --target-group-arn "$nlbArn" --targets Id="${LOCAL_IPV4}",Port=80 -echo "Fetching tags" -describe_tags=$(aws elbv2 describe-tags --resource-arns $(echo "$target_groups" | jq -r '.TargetGroups | .[] | .TargetGroupArn')) -for tag in "${TAGS[@]}"; do +aws elbv2 register-targets --target-group-arn "$nlb_target_group_arn" --targets Id="${LOCAL_IPV4}",Port=80 +ssh_target_group_arn=$(echo "$ip_based_target_groups_tags" | jq -r '.TagDescriptions | .[] | select(.Tags | any(.Key=="CentralReverseProxy") ) | .ResourceArn') +echo "Registering with ssh target group" +aws elbv2 register-targets --target-group-arn "$ssh_target_group_arn" --targets Id="${LOCAL_IPV4}",Port=80 +echo "Fetching tags for all target groups to identify which groups to add the new central proxy to" +# We fetch the tags of the target groups to identify those which the central reverse proxy should be added to. +# We depend on SAILING_TARGET_GROUP_NAME_PREFIX to filter out all target groups which point to sailing servers, +# because describe tags can take a maximum of 20 resource-arns. +describe_tags=$(aws elbv2 describe-tags --resource-arns $(echo "$target_groups" | jq -r '.TargetGroups | .[] | select(.TargetGroupName | startswith("S-") | not ) | select(.LoadBalancerArns | any(contains("loadbalancer/net") | not) ) | .TargetGroupArn')) +for tag in "${TARGET_GROUP_TAGS[@]}"; do echo "Adding to target groups with $tag" for tgArn in $(echo "$describe_tags" | jq -r '.TagDescriptions | .[] | select(.Tags | any(.Key=="'"$tag"'") ) | .ResourceArn'); do - if [[ "$tgArn" != "$nlbArn" ]]; then - echo "Registering in $tgArn as it has the correct tag" - aws elbv2 register-targets --target-group-arn "$tgArn" --targets Id="${INSTANCE_ID}" - [[ "$?" -eq 0 ]] || echo "Register target not successful" - fi + echo "Registering in $tgArn as it has the correct tag" + aws elbv2 register-targets --target-group-arn "$tgArn" --targets Id="${INSTANCE_ID}" + [[ "$?" -eq 0 ]] || echo "Registration of target was not successful" done done # alter records using batch file. sed -i "s/LOGFILES_INTERNAL_IP/$LOCAL_IPV4/" batch-for-route53-dns-record-update.json sed -i "s/SMTP_INTERNAL_IP/$LOCAL_IPV4/" batch-for-route53-dns-record-update.json -###### DO NOT ENABLE WHILST TESTING: aws route53 change-resource-record-sets --hosted-zone-id Z2JYWXYWLLRLTE --change-batch file://batch-for-route53-dns-record-update.json +HOSTED_ZONE_ID=$( aws route53 list-hosted-zones | \ + jq -r '.HostedZones[] | select(.Name == "sapsailing.com.").Id' | \ + sed -e 's|/hostedzone/||' ) +read -n 1 -p "Check the instance has the correct tags and is in the correct target group. +Furthermore, check the batch file batch-for-route53-dns-record-update.json has been modified correctly. +Press a key to continue.." key_pressed +aws route53 change-resource-record-sets --hosted-zone-id ${HOSTED_ZONE_ID} --change-batch file://batch-for-route53-dns-record-update.json # reload the nfs mountpoints. +echo "Waiting for records to change." +until $(host "logfiles.internal.sapsailing.com" | grep -q "$LOCAL_IPV4") && $(host "smtp.internal.sapsailing.com" | grep -q "$LOCAL_IPV4"); do + sleep 5 +done echo "Describing instances for remounting." describe_instances=$(aws ec2 describe-instances) +echo "Sailing servers: " for instanceIp in $(echo "$describe_instances" | select_instances_by_tag "sailing-analytics-server" | extract_public_ip); do echo "Remounting on $instanceIp" - ssh root@"${instanceIp}" "umount -l -f /var/log/old; umount -l -f /home/scores; mount -a" + ssh -o StrictHostKeyChecking=false root@"${instanceIp}" "umount -l -f /home/scores; mount -a" done +echo "Disposable reverse proxies: " for instanceIp in $(echo "$describe_instances" | select_instances_by_tag "DisposableProxy" | extract_public_ip); do echo "Remounting on $instanceIp" - ssh root@"${instanceIp}" "umount -l -f /var/log/old; mount -a" + ssh -o StrictHostKeyChecking=false root@"${instanceIp}" "umount -l -f /var/log/old; mount -a" done # Alter the elastic IP. # WARNING: Will terminate connections via the existing public ip. aws ec2 associate-address --instance-id "${INSTANCE_ID}" --public-ip "${ELASTIC_IP}" +git checkout main batch-for-route53-dns-record-update.json \ No newline at end of file diff --git a/configuration/environments_scripts/central_reverse_proxy/users/certbot/groups b/configuration/environments_scripts/central_reverse_proxy/users/certbot/groups new file mode 100644 index 00000000000..6d0eac4b37a --- /dev/null +++ b/configuration/environments_scripts/central_reverse_proxy/users/certbot/groups @@ -0,0 +1 @@ +docker \ No newline at end of file diff --git a/configuration/environments_scripts/repo/etc/logrotate.d/httpd b/configuration/environments_scripts/repo/etc/logrotate.d/httpd index 6b1f0b00876..8b0d93d9d6b 100644 --- a/configuration/environments_scripts/repo/etc/logrotate.d/httpd +++ b/configuration/environments_scripts/repo/etc/logrotate.d/httpd @@ -8,7 +8,7 @@ compress delaycompress postrotate - /bin/systemctl reload httpd.service > /dev/null 2>/dev/null || true + /usr/bin/systemctl reload httpd.service > /dev/null 2>/dev/null || true mv /var/log/logrotate-target/*.gz /var/log/old endscript } diff --git a/configuration/environments_scripts/repo/usr/local/bin/imageupgrade_functions.sh b/configuration/environments_scripts/repo/usr/local/bin/imageupgrade_functions.sh index 02caed32366..076630b726f 100755 --- a/configuration/environments_scripts/repo/usr/local/bin/imageupgrade_functions.sh +++ b/configuration/environments_scripts/repo/usr/local/bin/imageupgrade_functions.sh @@ -79,34 +79,113 @@ update_root_crontab() { } build_crontab_and_setup_files() { - # There must be at least 1 and all args are passed to build-crontab-and-cp-files. See the documentation of this file for more info. - if [[ "$#" -lt 1 ]]; then - echo "Number of arguments is invalid. There must be at least 1 and all args are passed to build-crontab-and-cp-files." + if [[ "$#" -eq 0 ]]; then + echo "Number of arguments is invalid. Please use the options and arguments as follows." + echo "Options for this function:" + echo " -h is the hostname to fetch the configuration/environments_scripts from." + echo "The remaining (optional) args and options, if correct, are passed to the build_crontab_and_setup_files script." + echo " -c means no crontab file is created" + echo " -n means that if a crontab has been created, it isn't actually installed. This is useful for testing." + echo " -f means no files are copied over, which is useful if you have already copied files accross or don't want to override existing files" + echo "Then there are the arguments, where the order matters:" + echo " ENVIRONMENT_TYPE - the directory name in environments_scripts which will be used." + echo " USER_WITH_COPY_OF_REPO - a user which will exist on the environment type, which has a checked out copy of the git workspace." + echo " RELATIVE_PATH_OF_GIT_DIR_WITHIN_USER - the relative path within the USER_WITH_COPY_OF_REPO to get to the git workspace." else - TEMP_ENVIRONMENTS_SCRIPTS=$(mktemp -d /root/environments_scripts_XXX) + TEMP=$(getopt -o fnch: -n 'options checker' -- "$@") + [[ "$?" -eq 0 ]] || return 2 + eval set -- "$TEMP" + PASS_OPTIONS=() + HOSTNAME="sapsailing.com" + while :; do + case "$1" in + -c|-f|-n) + PASS_OPTIONS+=("$1") + ;; + -h) + if [[ "$2" ]]; then + HOSTNAME="$2" + shift + else + echo "hostname option requires argument" + fi + ;; + --) + shift + break + ;; + *) + echo "no more options" + break + esac + shift + done + TEMP_ENVIRONMENTS_SCRIPTS=$(mktemp -d /var/tmp/environments_scripts_XXX) + echo "Attempting access to the wiki, typically used by image upgrade. Otherwise, try root. NOTE: If the first command fails, there will be a warning message." # During image upgrades, no environment type should have root access to the central server, but they do need # access to the wiki copy. Therefore, the various keys for different environment types are in the authorized_keys # of the wiki user. So, during image upgrade or to get the latest changes, the following command should succeed. # The wiki user's authorized_keys is not updated automatically with landscape managers, so # the below command may fail during initial image setup. In this scenario, the root user is instead the target # user of the scp command (as seen in the second command below). - scp -o StrictHostKeyChecking=no -pr "wiki@sapsailing.com:~/gitwiki/configuration/environments_scripts/*" "${TEMP_ENVIRONMENTS_SCRIPTS}" - [[ "$?" -eq 0 ]] || scp -o StrictHostKeyChecking=no -pr "root@sapsailing.com:/home/wiki/gitwiki/configuration/environments_scripts/*" "${TEMP_ENVIRONMENTS_SCRIPTS}" + scp -o StrictHostKeyChecking=no -pr wiki@"$HOSTNAME":~/gitwiki/configuration/environments_scripts/* "${TEMP_ENVIRONMENTS_SCRIPTS}" + [[ "$?" -eq 0 ]] || scp -o StrictHostKeyChecking=no -pr root@"$HOSTNAME":/home/wiki/gitwiki/configuration/environments_scripts/* "${TEMP_ENVIRONMENTS_SCRIPTS}" # For initial setup as not all landscape managers have direct wiki access. chown root:root "$TEMP_ENVIRONMENTS_SCRIPTS" cd "${TEMP_ENVIRONMENTS_SCRIPTS}" - ./build-crontab-and-cp-files $@ + # Add all args to array, otherwise, if PASS_OPTIONS is empty, and we also pass $@ then argument $1 is in fact null, which would cause errors. + for option in "$@"; do + PASS_OPTIONS+=( "$option") + done + if ! sudo ./build-crontab-and-cp-files "${PASS_OPTIONS[@]}"; then + return 1 + fi cd .. rm -rf "$TEMP_ENVIRONMENTS_SCRIPTS" fi } setup_keys() { - #1: Environment type. + # Installs the necessary aws and ssh keys for a given environment type, by copying from the key vault. + # $1: Environment type. + # Optional parameter is -p which indicates that no permissions will be set or overwritten. + TEMP=$(getopt -o p -n 'options' -- "$@") + [[ "$?" -eq 0 ]] || return 2 + SET_PERMISSIONS="true" + eval set -- "$TEMP" + while true; do + case "$1" in + -p) + SET_PERMISSIONS="false" + ;; + --) + shift + break + ;; + *) + echo "Option not recognised" + return 2 + ;; + esac + shift + done + if [[ "$#" -ne 1 ]]; then + echo "Please specify the environment type and use the optional -p flag to indicate that no permissions will be set or overwritten." + return 2 + fi pushd . - TEMP_KEY_DIR=$(mktemp -d /root/keysXXXXX) - REGION=$(TOKEN=`curl -X PUT "http://169.254.169.254/latest/api/token" --silent -H "X-aws-ec2-metadata-token-ttl-seconds: 21600"` \ - && curl -H "X-aws-ec2-metadata-token: $TOKEN" --silent http://169.254.169.254/latest/meta-data/placement/region) - scp -o StrictHostKeyChecking=no -pr root@sapsailing.com:/root/new_version_key_vault/"${1}"/* "${TEMP_KEY_DIR}" + TEMP_KEY_DIR=$(mktemp -d /var/tmp/keysXXXXX) + scp -o StrictHostKeyChecking=no -pr root@sapsailing.com:/root/key_vault/"${1}"/* "${TEMP_KEY_DIR}" + sudo su - -c "source imageupgrade_functions.sh; __setup_keys_using_local_copy $TEMP_KEY_DIR $SET_PERMISSIONS" + popd + rm -rf "${TEMP_KEY_DIR}" +} +__setup_keys_using_local_copy() { + # $1 the local location of the key_vault subdirectory corresponding to the image type this is run on. + # $2 a "true" or "false" string, indicating whether to override existing permissions. + # "true" indicates the permissions and ownership of the .ssh and .aws folders will not be set. + TEMP_KEY_DIR="$1" + SET_PERMISSIONS="$2" + REGION="$( ec2-metadata | grep "^placement:" | sed -e 's/^.*: \(.*\).$/\1/')" cd "${TEMP_KEY_DIR}" for user in *; do [[ -e "$user" ]] || continue @@ -115,7 +194,6 @@ setup_keys() { # aws setup if [[ -d "${user}/aws" ]]; then mkdir --parents "${user_home_dir}/.aws" - chmod 755 "${user_home_dir}"/.aws # Setup credentials if [[ -d "${user}/aws/credentials" && ! -e "${user_home_dir}/.aws/credentials" ]]; then > "${user_home_dir}"/.aws/credentials @@ -139,28 +217,34 @@ setup_keys() { done fi fi - chown -R ${user}:${user} "${user_home_dir}/.aws" - chmod 600 "${user_home_dir}"/.aws/* + if [[ "$SET_PERMISSIONS" == "true" ]]; then + chmod 755 "${user_home_dir}"/.aws + chown -R ${user}:${user} "${user_home_dir}/.aws" + chmod 600 "${user_home_dir}"/.aws/* + fi fi # ssh setup if [[ -d "${user}/ssh" ]]; then mkdir --parents "${user_home_dir}/.ssh" - chmod 700 "${user_home_dir}/.ssh" for key in "${user}"/ssh/*; do [[ -f "$key" ]] || continue + [[ ! -f "$user_home_dir"/.ssh/"$(basename "$key")" ]] || { echo "$key not touched, as it is already present in ssh dir of $user. You may want to override it." && continue; } \cp --preserve --dereference "$key" "$user_home_dir"/.ssh done for key in "${user}"/ssh/authorized_keys/*; do [[ -f "$key" ]] || continue - cat "${key}" >> ${user_home_dir}/.ssh/authorized_keys + if ! grep -q "$(cat "$key")" "${user_home_dir}"/.ssh/authorized_keys; then + cat "${key}" >> "${user_home_dir}"/.ssh/authorized_keys + fi done - chown -R ${user}:${user} "${user_home_dir}/.ssh" - chmod 600 "${user_home_dir}"/.ssh/* + if [[ "$SET_PERMISSIONS" == "true" ]]; then + chmod 700 "${user_home_dir}/.ssh" + chown -R ${user}:${user} "${user_home_dir}/.ssh" + chmod 600 "${user_home_dir}"/.ssh/* + fi fi fi done - popd - rm -rf "${TEMP_KEY_DIR}" } clean_root_ssh_dir_and_tmp() { @@ -327,7 +411,7 @@ setup_apachetop() { setup_swap() { # $1: size of swapspace in megabytes. - echo "Creating swapswpace of $1 MBs" + echo "Creating swapspace of $1 MBs" local swapfile_location=/var/cache/swapfile pushd . sudo dd if=/dev/zero of="$swapfile_location" bs=1M count="$1" @@ -337,4 +421,4 @@ setup_swap() { sudo su - -c "echo \"$swapfile_location none swap pri=0 0 0\" >> /etc/fstab" sudo swapon -a popd -} \ No newline at end of file +} diff --git a/configuration/environments_scripts/repo/usr/local/bin/setupHttpdGitLocal.sh b/configuration/environments_scripts/repo/usr/local/bin/setupHttpdGitLocal.sh index 7a647ea9e62..61d3c65bdf0 100755 --- a/configuration/environments_scripts/repo/usr/local/bin/setupHttpdGitLocal.sh +++ b/configuration/environments_scripts/repo/usr/local/bin/setupHttpdGitLocal.sh @@ -1,11 +1,15 @@ #!/bin/bash REMOTE=$1 BRANCH=$2 -GIT_USERNAME=$3 +GIT_USERNAME="$3" STATUS_DEFINITION_FILE="internal-server-status.conf" SELF_IP=$( ec2-metadata --local-ipv4 | grep -o "[0-9]\+\.[0-9]\+\.[0-9]\+\.[0-9]\+\>") cd /etc/httpd -if ! git status; then +if ! git status &>/dev/null; then + if [[ "$#" -ne 3 ]]; then + echo "Incorrect number of arguments" + exit 1 + fi echo "Currently not a git repo, creating and pulling latest changes" rm -rf .git rm -rf conf # Perhaps, this script should instead mv to a backup location @@ -15,8 +19,7 @@ if ! git status; then git remote add origin "${REMOTE}" GIT_SSH_COMMAND="ssh -A -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no" git fetch git checkout "$BRANCH" + git config user.name "$GIT_USERNAME" + git config user.email "nobody@$sapsailing.com" fi -echo "Use Status ${SELF_IP} internal-server-status" > /etc/httpd/conf.d/${STATUS_DEFINITION_FILE} -cd /etc/httpd -git config user.name "$GIT_USERNAME" -git config user.email "$(hostname)" \ No newline at end of file +echo "Use Status ${SELF_IP} internal-server-status" > /etc/httpd/conf.d/${STATUS_DEFINITION_FILE} \ No newline at end of file diff --git a/configuration/environments_scripts/repo/usr/local/bin/syncgit b/configuration/environments_scripts/repo/usr/local/bin/syncgit index a5f10a035a1..d21d700cdd9 100755 --- a/configuration/environments_scripts/repo/usr/local/bin/syncgit +++ b/configuration/environments_scripts/repo/usr/local/bin/syncgit @@ -1,16 +1,35 @@ #!/bin/sh +# Syncs the necessary branches of a repo at a specified location or, as default, +# /home/wiki/gitwiki. The assumed checked-out branch is master and the tracking branch +# is assumed to be origin master. ADMIN_EMAIL="axel.uhl@sap.com jan.hamann@sapsailing.com" if [ $# -eq 0 ]; then GIT_PATH="/home/wiki/gitwiki" else - GIT_PATH=$1 + GIT_PATH="$1" +fi +cd "$GIT_PATH" +git fetch github main:main >/tmp/wiki-git.out 2>/tmp/wiki-git.err +if [ "$?" != "0" ]; then + cat /tmp/wiki-git.out /tmp/wiki-git.err | mail -s "Wiki git problem: could not fetch github/main into local main" $ADMIN_EMAIL +fi +git push origin main:main >/tmp/wiki-git.out 2>/tmp/wiki-git.err +if [ "$?" != "0" ]; then + cat /tmp/wiki-git.out /tmp/wiki-git.err | mail -s "Wiki git problem: could not push main into sapsailing/main" $ADMIN_EMAIL +fi +git pull github main >/tmp/wiki-git.out 2>/tmp/wiki-git.err +if [ "$?" != "0" ]; then + cat /tmp/wiki-git.out /tmp/wiki-git.err | mail -s "Wiki git problem: could not merge github/main into sapsailing/master" $ADMIN_EMAIL fi -cd $GIT_PATH git pull >/tmp/wiki-git.out 2>/tmp/wiki-git.err if [ "$?" != "0" ]; then - cat /tmp/wiki-git.out /tmp/wiki-git.err | mail -s "Wiki git problem" $ADMIN_EMAIL + cat /tmp/wiki-git.out /tmp/wiki-git.err | mail -s "Wiki git problem: could not pull origin/master" $ADMIN_EMAIL +fi +git push origin master:main >>/tmp/wiki-git.out 2>/tmp/wiki-git.err +if [ "$?" != "0" ]; then + cat /tmp/wiki-git.out /tmp/wiki-git.err | mail -s "Wiki git problem: could not push master to origin/main" $ADMIN_EMAIL fi git push >>/tmp/wiki-git.out 2>/tmp/wiki-git.err if [ "$?" != "0" ]; then - cat /tmp/wiki-git.out /tmp/wiki-git.err | mail -s "Wiki git problem" $ADMIN_EMAIL + cat /tmp/wiki-git.out /tmp/wiki-git.err | mail -s "Wiki git problem: could not push master to origin/master" $ADMIN_EMAIL fi diff --git a/configuration/environments_scripts/repo/usr/local/bin/update_authorized_keys_for_landscape_managers_if_changed b/configuration/environments_scripts/repo/usr/local/bin/update_authorized_keys_for_landscape_managers_if_changed index 245fb85c075..39c84272b05 100755 --- a/configuration/environments_scripts/repo/usr/local/bin/update_authorized_keys_for_landscape_managers_if_changed +++ b/configuration/environments_scripts/repo/usr/local/bin/update_authorized_keys_for_landscape_managers_if_changed @@ -2,7 +2,9 @@ BEARER_TOKEN="$1" BASE_URL="$2" LOGON_USER_HOME="$3" -LAST_CHANGE_FILE=/var/run/last_change_aws_landscape_managers_ssh_keys +# We append the user home to the LAST_CHANGE_FILE so that if the script is ran for multiple users, they each have their +# own LAST_CHANGE_FILE. Note, that we have to replace the slash character. +LAST_CHANGE_FILE=/var/run/last_change_aws_landscape_managers_ssh_keys_"$(echo "$LOGON_USER_HOME" | sed "s|/|_|g")" # Uncomment the following for production use, with no error output curl_output=$( curl -H 'X-SAPSSE-Forward-Request-To: master' -H 'Authorization: Bearer '${BEARER_TOKEN} "${BASE_URL}/landscape/api/landscape/get_time_point_of_last_change_in_ssh_keys_of_aws_landscape_managers" 2>/dev/null ) curl_exit_code=$? diff --git a/configuration/environments_scripts/repo/var/www/cgi-bin/reverseProxyHealthcheck.sh b/configuration/environments_scripts/repo/var/www/cgi-bin/reverseProxyHealthcheck.sh index e721f964aac..76b5c80f0d7 100755 --- a/configuration/environments_scripts/repo/var/www/cgi-bin/reverseProxyHealthcheck.sh +++ b/configuration/environments_scripts/repo/var/www/cgi-bin/reverseProxyHealthcheck.sh @@ -101,11 +101,28 @@ randomise() { echo $(($RANDOM % 5 + $1 )) } +getListOfIpsForCidr() { + # $1: a CIDR, such as 172.10.0.0/32 + # Outputs the list of IP addresses that match the CIDR. + # Tries to read this from a file in ${CACHE_LOCATION} + # whose name is inferred from the CIDR parameter. If not + # found, nmap is used to produce that list, and it is + # written to the file in the ${CACHE_LOCATION} so it can + # be found the next time requested + cidr="${1}" + FILE_WITH_IPS_FOR_CIDR=${CACHE_LOCATION}/$( echo "${cidr}" | tr '/' '_' ) + if [ -f ${FILE_WITH_IPS_FOR_CIDR} ]; then + cat ${FILE_WITH_IPS_FOR_CIDR} + else + nmap -sL -n ${cidr} | head -n -1 | tail -n +2 | sed -e 's/^.*\<\([0-9]*\.[0-9]*\.[0-9]*\.[0-9]*\)$/\1/' | tee ${FILE_WITH_IPS_FOR_CIDR} + fi +} + getAzCidr() { # $1: path to a file containing one CIDR per line # $2: an IP address to obtain the subnet CIDR for for cidr in $( cat "${1}" ); do - if nmap -sL -n ${cidr} | head -n -1 | tail -n +2 | grep -q ${2}; then + if getListOfIpsForCidr ${cidr} | grep -q ${2}; then echo ${cidr} fi done diff --git a/configuration/tractrac-json-urls b/configuration/tractrac-json-urls index d42283414c9..86651f335a8 100644 --- a/configuration/tractrac-json-urls +++ b/configuration/tractrac-json-urls @@ -434,6 +434,7 @@ https://event3.tractrac.com/events/event_20231105_Europeaner/jsonservice.php https://event3.tractrac.com/events/event_20240129_HongKongRa/jsonservice.php https://event3.tractrac.com/events/event_20240223_WORLDCHAMP/jsonservice.php https://event3.tractrac.com/events/event_20240304_erWorldCha/jsonservice.php +https://event3.tractrac.com/events/event_20240606_HelgaCup/jsonservice.php https://event.tractrac.com/events/event_20170727_Travemnder2/jsonservice.php https://event.tractrac.com/events/event_20171013_DSLPokalGl/jsonservice.php https://event.tractrac.com/events/event_20181012_MstarnasMs/jsonservice.php diff --git a/docker/Dockerfile-raspi.tpl b/docker/Dockerfile-raspi.tpl deleted file mode 100755 index 6cda42db1e4..00000000000 --- a/docker/Dockerfile-raspi.tpl +++ /dev/null @@ -1,18 +0,0 @@ -FROM donaldduck70/openjdk:1.8.0_242 -LABEL maintainer=axel.uhl@gmx.de -# Download and extract the release -WORKDIR /home/sailing/servers/server -RUN apt-get update \ - && apt-get install -y vim telnet dnsutils net-tools jq -COPY vimrc /root/.vimrc -RUN wget -O /tmp/rds.pem https://s3.amazonaws.com/rds-downloads/rds-combined-ca-bundle.pem \ - && keytool -importcert -alias AWSRDS -file /tmp/rds.pem -keystore /usr/lib/jvm/java-8-openjdk-arm64/jre/lib/security/cacerts -noprompt -storepass changeit \ - && rm /tmp/rds.pem -RUN wget -O /tmp/RELEASE.tar.gz http://releases.sapsailing.com/RELEASE/RELEASE.tar.gz \ - && tar xzvpf /tmp/RELEASE.tar.gz \ - && rm /tmp/RELEASE.tar.gz -COPY env.sh . -COPY start . -COPY JavaSE-11.profile . -EXPOSE 8888 14888 8000 7091 6666 -CMD [ "/home/sailing/servers/server/start", "fg" ] diff --git a/docker/docker-compose-17.yml b/docker/docker-compose-17.yml index 3661e89b978..6de89609bf9 100644 --- a/docker/docker-compose-17.yml +++ b/docker/docker-compose-17.yml @@ -1,7 +1,7 @@ version: "3.10" services: sailing-analytics: - image: "ghcr.io/sap/sailing-analytics:latest-17" + image: "ghcr.io/sap/sailing-analytics:latest-17" ports: - "8888:8888" - "6666:6666" diff --git a/docker/makeImageForLatestRelease b/docker/makeImageForLatestRelease index b7aa741a07c..daaccfeb9b4 100755 --- a/docker/makeImageForLatestRelease +++ b/docker/makeImageForLatestRelease @@ -19,13 +19,9 @@ else cp "$GITROOT/java/target/start" "$DOCKERDIR" cp "$GITROOT/java/target/configuration/JavaSE-11.profile" "$DOCKERDIR" cd "$DOCKERDIR" - docker build --build-arg RELEASE=${release} -t ghcr.io/sap/sailing-analytics:${release} . + docker buildx create --name=container --driver=docker-container --use --bootstrap + docker buildx build --builder=container --platform=linux/amd64,linux/arm64 --build-arg RELEASE=${release} -t ghcr.io/sap/sailing-analytics:${release} --push . echo "Cleaning up..." rm start env.sh JavaSE-11.profile ${RELEASE_TAR_GZ_FILENAME} release-notes.txt - docker push ghcr.io/sap/sailing-analytics:${release} - if [ "$SET_LATEST" = "1" ]; then - docker tag ghcr.io/sap/sailing-analytics:${release} ghcr.io/sap/sailing-analytics:latest - docker push ghcr.io/sap/sailing-analytics:latest - fi fi popd diff --git a/docker/makeImageForLatestRelease-arm b/docker/makeImageForLatestRelease-arm new file mode 100755 index 00000000000..45ee6485b36 --- /dev/null +++ b/docker/makeImageForLatestRelease-arm @@ -0,0 +1,31 @@ +#!/bin/bash +release_prefix=$1 +GITROOT="`dirname $0`/.." +DOCKERDIR="${GITROOT}/docker" +DOCKERFILE="$DOCKERDIR/Dockerfile" +if [ "${release_prefix}" = "" ]; then + SET_LATEST=1 + release_prefix="main-" +fi +pushd "${DOCKERDIR}" +RELEASE_TAR_GZ_FILENAME=$( ${GITROOT}/configuration/github-download-release-assets.sh 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 "${release_prefix}" ) +if [ "${RELEASE_TAR_GZ_FILENAME}" = "" ]; then + echo "No release with prefix ${release_prefix} found" >&2 +else + release=$( echo ${RELEASE_TAR_GZ_FILENAME} | sed -e 's/\.tar\.gz//' ) + echo Release is ${release} + echo "Copying files from GITROOT $GITROOT into Docker workspace" + cp "$GITROOT/java/target/env.sh" "$DOCKERDIR" + cp "$GITROOT/java/target/start" "$DOCKERDIR" + cp "$GITROOT/java/target/configuration/JavaSE-11.profile" "$DOCKERDIR" + cd "$DOCKERDIR" + docker build --build-arg RELEASE=${release} -t ghcr.io/sap/sailing-analytics:${release}-arm . + echo "Cleaning up..." + rm start env.sh JavaSE-11.profile ${RELEASE_TAR_GZ_FILENAME} release-notes.txt + docker push ghcr.io/sap/sailing-analytics:${release}-arm + if [ "$SET_LATEST" = "1" ]; then + docker tag ghcr.io/sap/sailing-analytics:${release}-arm ghcr.io/sap/sailing-analytics:latest-arm + docker push ghcr.io/sap/sailing-analytics:latest-arm + fi +fi +popd diff --git a/docker/makeImageForLatestRelease-raspi b/docker/makeImageForLatestRelease-raspi deleted file mode 100755 index a5b0477f3fb..00000000000 --- a/docker/makeImageForLatestRelease-raspi +++ /dev/null @@ -1,25 +0,0 @@ -#!/bin/bash -release=$1 -if [ "${release}" = "" ]; then - SET_LATEST=1 - release=$(wget -O - http://releases.sapsailing.com/ 2>/dev/null | grep build- | tail -1 | sed -e 's/^.*\(build-[0-9]*\).*$/\1/') - echo Latest release is ${release} -fi -GITROOT="`dirname $0`/.." -DOCKERDIR="${GITROOT}/docker" -DOCKERFILE="$DOCKERDIR/Dockerfile-raspi" -echo "Copying files from GITROOT $GITROOT into Docker workspace" -cp "$GITROOT/java/target/env.sh" "$DOCKERDIR" -cp "$GITROOT/java/target/start" "$DOCKERDIR" -cp "$GITROOT/java/target/configuration/JavaSE-11.profile" "$DOCKERDIR" -cat ${DOCKERFILE}.tpl | sed -e "s/RELEASE/${release}/g" >${DOCKERFILE} -cd "$DOCKERDIR" -docker build -t sapsailing:${release}-raspi -f ${DOCKERFILE} . -echo "Cleaning up..." -rm start env.sh JavaSE-11.profile ${Dockerfile} -docker tag sapsailing:${release}-raspi donaldduck70/sapsailing:${release}-raspi -docker push donaldduck70/sapsailing:${release}-raspi -if [ "$SET_LATEST" = "1" ]; then - docker tag sapsailing:${release}-raspi donaldduck70/sapsailing:latest-raspi - docker push donaldduck70/sapsailing:latest-raspi -fi diff --git a/java/com.sap.sailing.domain.common/src/com/sap/sailing/domain/common/LeaderboardNameConstants.java b/java/com.sap.sailing.domain.common/src/com/sap/sailing/domain/common/LeaderboardNameConstants.java index 259243684c7..18947f19765 100755 --- a/java/com.sap.sailing.domain.common/src/com/sap/sailing/domain/common/LeaderboardNameConstants.java +++ b/java/com.sap.sailing.domain.common/src/com/sap/sailing/domain/common/LeaderboardNameConstants.java @@ -14,6 +14,7 @@ public interface LeaderboardNameConstants { static final String SCORINGSCHEME = "scoringScheme"; static final String SCORINGCOMMENT = "scoringComment"; static final String LASTSCORINGUPDATE = "lastScoringUpdate"; + static final String LASTSCORINGUPDATE_MILLIS = "lastScoringUpdate-ms"; static final String REGATTANAME = "regattaName"; static final String SERIES = "series"; static final String ISMEDALSERIES = "isMedalSeries"; diff --git a/java/com.sap.sailing.domain.persistence/src/com/sap/sailing/domain/persistence/PersistenceFactory.java b/java/com.sap.sailing.domain.persistence/src/com/sap/sailing/domain/persistence/PersistenceFactory.java index cae844c76e9..0ff5407d0b6 100755 --- a/java/com.sap.sailing.domain.persistence/src/com/sap/sailing/domain/persistence/PersistenceFactory.java +++ b/java/com.sap.sailing.domain.persistence/src/com/sap/sailing/domain/persistence/PersistenceFactory.java @@ -10,9 +10,11 @@ public interface PersistenceFactory { DomainObjectFactory getDefaultDomainObjectFactory(); DomainObjectFactory getDomainObjectFactory(MongoDBService mongoDBService, DomainFactory baseDomainFactory); + DomainObjectFactory getMajorityDomainObjectFactory(MongoDBService mongoDBService, DomainFactory baseDomainFactory); DomainObjectFactory getDomainObjectFactory(MongoDBService mongoDBService, DomainFactory baseDomainFactory, TypeBasedServiceFinderFactory serviceFinderFactory); MongoObjectFactory getDefaultMongoObjectFactory(); MongoObjectFactory getMongoObjectFactory(MongoDBService mongoDBService); + MongoObjectFactory getMajorityMongoObjectFactory(MongoDBService mongoDBService); MongoObjectFactory getDefaultMongoObjectFactory(TypeBasedServiceFinderFactory serviceFinderFactory); MongoObjectFactory getMongoObjectFactory(MongoDBService mongoDBService, TypeBasedServiceFinderFactory serviceFinderFactory); } diff --git a/java/com.sap.sailing.domain.persistence/src/com/sap/sailing/domain/persistence/impl/PersistenceFactoryImpl.java b/java/com.sap.sailing.domain.persistence/src/com/sap/sailing/domain/persistence/impl/PersistenceFactoryImpl.java index 646bcddfdf2..3075be202cc 100755 --- a/java/com.sap.sailing.domain.persistence/src/com/sap/sailing/domain/persistence/impl/PersistenceFactoryImpl.java +++ b/java/com.sap.sailing.domain.persistence/src/com/sap/sailing/domain/persistence/impl/PersistenceFactoryImpl.java @@ -1,5 +1,7 @@ package com.sap.sailing.domain.persistence.impl; +import com.mongodb.ReadConcern; +import com.mongodb.WriteConcern; import com.sap.sailing.domain.base.DomainFactory; import com.sap.sailing.domain.persistence.DomainObjectFactory; import com.sap.sailing.domain.persistence.MongoObjectFactory; @@ -31,6 +33,11 @@ public class PersistenceFactoryImpl implements PersistenceFactory { return new DomainObjectFactoryImpl(mongoDBService.getDB(), baseDomainFactory); } + @Override + public DomainObjectFactory getMajorityDomainObjectFactory(MongoDBService mongoDBService, DomainFactory baseDomainFactory) { + return new DomainObjectFactoryImpl(mongoDBService.getDB().withReadConcern(ReadConcern.MAJORITY).withWriteConcern(WriteConcern.MAJORITY), baseDomainFactory); + } + @Override public DomainObjectFactory getDomainObjectFactory(MongoDBService mongoDBService, DomainFactory baseDomainFactory, TypeBasedServiceFinderFactory serviceFinderFactory) { @@ -52,6 +59,11 @@ public class PersistenceFactoryImpl implements PersistenceFactory { return new MongoObjectFactoryImpl(mongoDBService.getDB()); } + @Override + public MongoObjectFactory getMajorityMongoObjectFactory(MongoDBService mongoDBService) { + return new MongoObjectFactoryImpl(mongoDBService.getDB().withReadConcern(ReadConcern.MAJORITY).withWriteConcern(WriteConcern.MAJORITY)); + } + @Override public MongoObjectFactory getMongoObjectFactory(MongoDBService mongoDBService, TypeBasedServiceFinderFactory serviceFinderFactory) { return new MongoObjectFactoryImpl(mongoDBService.getDB(), serviceFinderFactory); diff --git a/java/com.sap.sailing.domain.tractracadapter/src/com/sap/sailing/domain/tractracadapter/impl/RaceAndCompetitorStatusWithRaceLogReconciler.java b/java/com.sap.sailing.domain.tractracadapter/src/com/sap/sailing/domain/tractracadapter/impl/RaceAndCompetitorStatusWithRaceLogReconciler.java index 65d99fb9902..20d91b82124 100755 --- a/java/com.sap.sailing.domain.tractracadapter/src/com/sap/sailing/domain/tractracadapter/impl/RaceAndCompetitorStatusWithRaceLogReconciler.java +++ b/java/com.sap.sailing.domain.tractracadapter/src/com/sap/sailing/domain/tractracadapter/impl/RaceAndCompetitorStatusWithRaceLogReconciler.java @@ -311,68 +311,81 @@ public class RaceAndCompetitorStatusWithRaceLogReconciler { */ private MaxPointsReason getMaxPointsReason(RaceCompetitorStatusType raceCompetitorStatusType) { MaxPointsReason result; - switch (raceCompetitorStatusType) { - // TODO we expect NSC and perhaps also TLE to show up; support the mapping to MaxPointsReason.NSC / TLE, respectively when they appear - case ABANDONED: - result = MaxPointsReason.NONE; // TODO bug 5154: find out what ABANDONED means and if/how we can translate it to a MaxPointsReason - break; - case BFD: - result = MaxPointsReason.BFD; - break; - case DISQUALIFIED: - result = MaxPointsReason.DSQ; - break; - case DNC: - result = MaxPointsReason.DNC; - break; - case DNF: - result = MaxPointsReason.DNF; - break; - case DONT_RACE: - result = MaxPointsReason.DNS; // TODO bug 5154: find out what DONT_RACE means and if/how we can translate it to a MaxPointsReason; is it DNS? - break; - case FIN: - result = MaxPointsReason.NONE; // TODO bug 5154: find out what FIN means and if/how we can translate it to a MaxPointsReason; does it mean the competitor finished properly? - break; - case FINISH_CONFIRMED: - result = MaxPointsReason.NONE; // TODO bug 5154: find out what FINISH_CONFIRMED means and if/how we can translate it to a MaxPointsReason; does it mean the competitor finished properly? - break; - case MIS: - result = MaxPointsReason.NONE; // TODO bug 5154: find out what MIS means and if/how we can translate it to a MaxPointsReason; does it mean the competitor is "missing?" - break; - case NO_COLLECT: - result = MaxPointsReason.NONE; // TODO bug 5154: find out what NO_COLLECT means and if/how we can translate it to a MaxPointsReason - break; - case NO_DATA: + if (raceCompetitorStatusType == null) { result = MaxPointsReason.NONE; - break; - case OCS: - result = MaxPointsReason.OCS; - break; - case RACING: - result = MaxPointsReason.NONE; - break; - case RETIRED: - result = MaxPointsReason.RET; - break; - case UFD: - result = MaxPointsReason.UFD; - break; - case NSC: - result = MaxPointsReason.NSC; - break; - case TLE: - result = MaxPointsReason.TLE; - break; - case SCP: - result = MaxPointsReason.SCP; - break; - case STP: - result = MaxPointsReason.STP; - break; - default: - result = MaxPointsReason.NONE; - break; + } else { + switch (raceCompetitorStatusType) { + // TODO we expect NSC and perhaps also TLE to show up; support the mapping to MaxPointsReason.NSC / TLE, respectively when they appear + case ABANDONED: + result = MaxPointsReason.NONE; // TODO bug 5154: find out what ABANDONED means and if/how we can translate it to a MaxPointsReason + break; + case BFD: + result = MaxPointsReason.BFD; + break; + case DISQUALIFIED: + result = MaxPointsReason.DSQ; + break; + case DNC: + result = MaxPointsReason.DNC; + break; + case DNF: + result = MaxPointsReason.DNF; + break; + case DONT_RACE: + result = MaxPointsReason.DNS; // TODO bug 5154: find out what DONT_RACE means and if/how we can translate it to a MaxPointsReason; is it DNS? + break; + case FIN: + result = MaxPointsReason.NONE; // TODO bug 5154: find out what FIN means and if/how we can translate it to a MaxPointsReason; does it mean the competitor finished properly? + break; + case FINISH_CONFIRMED: + result = MaxPointsReason.NONE; // TODO bug 5154: find out what FINISH_CONFIRMED means and if/how we can translate it to a MaxPointsReason; does it mean the competitor finished properly? + break; + case MIS: + result = MaxPointsReason.NONE; // TODO bug 5154: find out what MIS means and if/how we can translate it to a MaxPointsReason; does it mean the competitor is "missing?" + break; + case NO_COLLECT: + result = MaxPointsReason.NONE; // TODO bug 5154: find out what NO_COLLECT means and if/how we can translate it to a MaxPointsReason + break; + case NO_DATA: + result = MaxPointsReason.NONE; + break; + case OCS: + result = MaxPointsReason.OCS; + break; + case RACING: + result = MaxPointsReason.NONE; + break; + case RETIRED: + result = MaxPointsReason.RET; + break; + case UFD: + result = MaxPointsReason.UFD; + break; + case NSC: + result = MaxPointsReason.NSC; + break; + case TLE: + result = MaxPointsReason.TLE; + break; + case SCP: + result = MaxPointsReason.SCP; + break; + case STP: + result = MaxPointsReason.STP; + break; + case DCT: + result = MaxPointsReason.DCT; + break; + case DNE: + result = MaxPointsReason.DNE; + break; + case RCT: + result = MaxPointsReason.RCT; + break; + default: + result = MaxPointsReason.NONE; + break; + } } return result; } diff --git a/java/com.sap.sailing.domain/src/com/sap/sailing/domain/ranking/NonPerformanceCurveRankingMetric.java b/java/com.sap.sailing.domain/src/com/sap/sailing/domain/ranking/NonPerformanceCurveRankingMetric.java index d35fd3bc602..09f9a50aaab 100755 --- a/java/com.sap.sailing.domain/src/com/sap/sailing/domain/ranking/NonPerformanceCurveRankingMetric.java +++ b/java/com.sap.sailing.domain/src/com/sap/sailing/domain/ranking/NonPerformanceCurveRankingMetric.java @@ -192,7 +192,7 @@ public abstract class NonPerformanceCurveRankingMetric extends AbstractRankingMe final Competitor who = legWho.getCompetitor(); final Competitor to = legTo.getCompetitor(); if (who == to) { - if (isAssumedToHaveFinishedLeg(timePoint, legWho)) { + if (isAssumedToHaveFinishedLeg(timePoint, legWho) && legWho.getFinishTime() != null) { result = timePoint.until(legWho.getFinishTime()); // negative time; reached end of leg some time ago } else { result = Duration.NULL; // still racing in the leg; reaches its own position in no time diff --git a/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/home/desktop/places/whatsnew/resources/SailingAnalyticsNotes.html b/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/home/desktop/places/whatsnew/resources/SailingAnalyticsNotes.html index e0b28d6e334..1bcf2c8abaf 100755 --- a/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/home/desktop/places/whatsnew/resources/SailingAnalyticsNotes.html +++ b/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/home/desktop/places/whatsnew/resources/SailingAnalyticsNotes.html @@ -5,6 +5,14 @@

What's New - SAP Sailing Analytics

+
June 2024
+
    +
  • Added the timepoint-ms and lastScoringUpdate-ms fields to the + /sailingserver/api/v1/leaderboardgroups/{id|name} + response which reports the time point as the number of milliseconds since the epoch (1970-01-01T00:00:00Z, "Unix time"). + The timepoint and lastScoringUpdate fields' format is not easily machine-readable, + but we're not changing the format for reasons of backward compatibility.
  • +
April 2024
  • Added the trueheading-deg field to the competitor GPS fix export if the tracker has provided it.
  • diff --git a/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/server/SailingServiceWriteImpl.java b/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/server/SailingServiceWriteImpl.java index b5cc1ba9693..2e4179f7686 100644 --- a/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/server/SailingServiceWriteImpl.java +++ b/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/server/SailingServiceWriteImpl.java @@ -1529,6 +1529,7 @@ public class SailingServiceWriteImpl extends SailingServiceImpl implements Saili new Callable() { @Override public EventDTO call() throws Exception { + logger.info("User "+SecurityUtils.getSubject().getPrincipal()+" is trying to create event "+eventName); final TimePoint startTimePoint = startDate != null ? new MillisecondsTimePoint(startDate) : null; final TimePoint endTimePoint = endDate != null ? new MillisecondsTimePoint(endDate) : null; final URL officialWebsiteURL = officialWebsiteURLAsString != null @@ -1711,14 +1712,15 @@ public class SailingServiceWriteImpl extends SailingServiceImpl implements Saili RegattaCreationParametersDTO seriesNamesWithFleetNamesAndFleetOrderingAndMedal, boolean persistent, ScoringSchemeType scoringSchemeType, List courseAreaIds, Double buoyZoneRadiusInHullLengths, boolean useStartTimeInference, boolean controlTrackingFromStartAndFinishTimes, boolean autoRestartTrackingUponCompetitorSetChange, RankingMetrics rankingMetricType) { + logger.info("User "+SecurityUtils.getSubject().getPrincipal()+" is trying to create regatta "+regattaName); return getSecurityService().setOwnershipCheckPermissionForObjectCreationAndRevertOnError( SecuredDomainType.REGATTA, Regatta.getTypeRelativeObjectIdentifier(regattaName), regattaName, new Callable() { @Override public RegattaDTO call() throws Exception { - TimePoint startTimePoint = startDate != null ? new MillisecondsTimePoint(startDate) : null; - TimePoint endTimePoint = endDate != null ? new MillisecondsTimePoint(endDate) : null; - Regatta regatta = getService().apply(new AddSpecificRegatta(regattaName, boatClassName, + final TimePoint startTimePoint = startDate != null ? new MillisecondsTimePoint(startDate) : null; + final TimePoint endTimePoint = endDate != null ? new MillisecondsTimePoint(endDate) : null; + final Regatta regatta = getService().apply(new AddSpecificRegatta(regattaName, boatClassName, canBoatsOfCompetitorsChangePerRace, competitorRegistrationType, registrationLinkSecret, startTimePoint, endTimePoint, UUID.randomUUID(), seriesNamesWithFleetNamesAndFleetOrderingAndMedal, persistent, diff --git a/java/com.sap.sailing.server.gateway.serialization.shared.android/src/com/sap/sailing/server/gateway/serialization/LeaderboardGroupConstants.java b/java/com.sap.sailing.server.gateway.serialization.shared.android/src/com/sap/sailing/server/gateway/serialization/LeaderboardGroupConstants.java index 21bfd9dd926..4647d78a2c2 100755 --- a/java/com.sap.sailing.server.gateway.serialization.shared.android/src/com/sap/sailing/server/gateway/serialization/LeaderboardGroupConstants.java +++ b/java/com.sap.sailing.server.gateway.serialization.shared.android/src/com/sap/sailing/server/gateway/serialization/LeaderboardGroupConstants.java @@ -6,6 +6,7 @@ public interface LeaderboardGroupConstants { String DISPLAYNAME = "displayName"; String DESCRIPTION = "description"; String TIMEPOINT = "timepoint"; + String TIMEPOINT_MILLIS = "timepoint-ms"; String EVENTS = "events"; String LEADERBOARDS = "leaderboards"; } diff --git a/java/com.sap.sailing.server.gateway/src/com/sap/sailing/server/gateway/jaxrs/api/EventsResource.java b/java/com.sap.sailing.server.gateway/src/com/sap/sailing/server/gateway/jaxrs/api/EventsResource.java index 23599f7f736..b53fbd533dc 100644 --- a/java/com.sap.sailing.server.gateway/src/com/sap/sailing/server/gateway/jaxrs/api/EventsResource.java +++ b/java/com.sap.sailing.server.gateway/src/com/sap/sailing/server/gateway/jaxrs/api/EventsResource.java @@ -608,6 +608,7 @@ public class EventsResource extends AbstractSailingServerResource { Callable> doCreationAction = new Callable>() { @Override public Util.Triple call() throws Exception { + logger.info("User "+SecurityUtils.getSubject().getPrincipal()+" is trying to create event "+eventName); Event event = getSecurityService().setOwnershipCheckPermissionForObjectCreationAndRevertOnError( SecuredDomainType.EVENT, EventBaseImpl.getTypeRelativeObjectIdentifier(eventId), eventName, ()->getService().apply(new CreateEvent(eventName, eventDescription, startDate, endDate, venueName, isPublic, eventId, diff --git a/java/com.sap.sailing.server.gateway/src/com/sap/sailing/server/gateway/jaxrs/api/LeaderboardGroupsResource.java b/java/com.sap.sailing.server.gateway/src/com/sap/sailing/server/gateway/jaxrs/api/LeaderboardGroupsResource.java index fa3a4daa718..7d95f9cfce6 100644 --- a/java/com.sap.sailing.server.gateway/src/com/sap/sailing/server/gateway/jaxrs/api/LeaderboardGroupsResource.java +++ b/java/com.sap.sailing.server.gateway/src/com/sap/sailing/server/gateway/jaxrs/api/LeaderboardGroupsResource.java @@ -139,15 +139,16 @@ public class LeaderboardGroupsResource extends AbstractSailingServerResource { .type(MediaType.TEXT_PLAIN).build(); } else { if (getSecurityService().hasCurrentUserReadPermission(leaderboardGroup)) { - TimePoint timePoint = MillisecondsTimePoint.now(); - JSONObject jsonLeaderboardGroup = new JSONObject(); + final TimePoint timePoint = MillisecondsTimePoint.now(); + final JSONObject jsonLeaderboardGroup = new JSONObject(); jsonLeaderboardGroup.put(LeaderboardGroupConstants.NAME, leaderboardGroup.getName()); jsonLeaderboardGroup.put(LeaderboardGroupConstants.ID, leaderboardGroup.getId().toString()); jsonLeaderboardGroup.put(LeaderboardGroupConstants.DISPLAYNAME, leaderboardGroup.getDisplayName()); jsonLeaderboardGroup.put(LeaderboardGroupConstants.DESCRIPTION, leaderboardGroup.getDescription()); jsonLeaderboardGroup.put(LeaderboardGroupConstants.TIMEPOINT, timePoint.toString()); + jsonLeaderboardGroup.put(LeaderboardGroupConstants.TIMEPOINT_MILLIS, timePoint.asMillis()); final Set eventsReferencingLeaderboardGroup = new HashSet<>(); - JSONArray idsOfEventsReferencingLeaderboardGroup = new JSONArray(); + final JSONArray idsOfEventsReferencingLeaderboardGroup = new JSONArray(); for (final Event event : getService().getAllEvents()) { if (Util.contains(event.getLeaderboardGroups(), leaderboardGroup)) { eventsReferencingLeaderboardGroup.add(event); @@ -173,6 +174,8 @@ public class LeaderboardGroupsResource extends AbstractSailingServerResource { TimePoint lastUpdateTimepoint = scoreCorrection.getTimePointOfLastCorrectionsValidity(); jsonLeaderboard.put(LeaderboardNameConstants.LASTSCORINGUPDATE, lastUpdateTimepoint != null ? lastUpdateTimepoint.asDate().toString() : null); + jsonLeaderboard.put(LeaderboardNameConstants.LASTSCORINGUPDATE_MILLIS, + lastUpdateTimepoint != null ? lastUpdateTimepoint.asMillis() : null); } else { jsonLeaderboard.put(LeaderboardNameConstants.SCORINGCOMMENT, null); jsonLeaderboard.put(LeaderboardNameConstants.LASTSCORINGUPDATE, null); diff --git a/java/com.sap.sailing.server.gateway/src/com/sap/sailing/server/gateway/trackfiles/impl/ExpeditionAllInOneImporter.java b/java/com.sap.sailing.server.gateway/src/com/sap/sailing/server/gateway/trackfiles/impl/ExpeditionAllInOneImporter.java index 12fa5926002..cb3d1a1dbad 100644 --- a/java/com.sap.sailing.server.gateway/src/com/sap/sailing/server/gateway/trackfiles/impl/ExpeditionAllInOneImporter.java +++ b/java/com.sap.sailing.server.gateway/src/com/sap/sailing/server/gateway/trackfiles/impl/ExpeditionAllInOneImporter.java @@ -27,6 +27,7 @@ import java.util.stream.Collectors; import java.util.stream.StreamSupport; import org.apache.commons.fileupload.FileItem; +import org.apache.shiro.SecurityUtils; import org.apache.shiro.authz.AuthorizationException; import org.apache.shiro.subject.Subject; import org.json.simple.parser.ParseException; @@ -329,6 +330,7 @@ public class ExpeditionAllInOneImporter { final TimePointsOfFirstAndLastFix firstAndLastFixAt = importFixes(filenameWithSuffix, fileItem, jsonHolderForGpsFixImport, jsonHolderForSensorFixImport, errors); final TimePoint eventStartDate = firstAndLastFixAt.getFirstFixAt(); final TimePoint eventEndDate = firstAndLastFixAt.getLastFixAt(); + logger.info("Trying to create event "+eventName+" and regatta "+regattaName+" on behalf of user "+SecurityUtils.getSubject().getPrincipal()); final Iterable> trackedRacesAndRaceColumnNamesAndFleetNames = createEventStructureWithASingleRaceAndTrackIt( filenameWithSuffix, boatClassName, errors, importTimeString, filename, diff --git a/java/com.sap.sailing.server.interface/src/com/sap/sailing/server/operationaltransformation/AddSpecificRegatta.java b/java/com.sap.sailing.server.interface/src/com/sap/sailing/server/operationaltransformation/AddSpecificRegatta.java index 49dbf4162ac..5b639100cea 100755 --- a/java/com.sap.sailing.server.interface/src/com/sap/sailing/server/operationaltransformation/AddSpecificRegatta.java +++ b/java/com.sap.sailing.server.interface/src/com/sap/sailing/server/operationaltransformation/AddSpecificRegatta.java @@ -71,7 +71,7 @@ public class AddSpecificRegatta extends AbstractAddRegattaOperation { @Override public Regatta internalApplyTo(RacingEventService toState) throws Exception { - Regatta regatta = toState.createRegatta(getRegattaName(), getBoatClassName(), + final Regatta regatta = toState.createRegatta(getRegattaName(), getBoatClassName(), canBoatsOfCompetitorsChangePerRace, competitorRegistrationType, registrationLinkSecret, getStartDate(), getEndDate(), getId(), createSeries(toState), persistent, scoringScheme, courseAreaIds, buoyZoneRadiusInHullLengths, useStartTimeInference, controlTrackingFromStartAndFinishTimes, diff --git a/java/com.sap.sailing.server.replication.test/src/com/sap/sailing/server/replication/test/AbstractLogReplicationTest.java b/java/com.sap.sailing.server.replication.test/src/com/sap/sailing/server/replication/test/AbstractLogReplicationTest.java index b7439545382..b8a296b9d46 100644 --- a/java/com.sap.sailing.server.replication.test/src/com/sap/sailing/server/replication/test/AbstractLogReplicationTest.java +++ b/java/com.sap.sailing.server.replication.test/src/com/sap/sailing/server/replication/test/AbstractLogReplicationTest.java @@ -14,9 +14,12 @@ import com.sap.sailing.domain.abstractlog.AbstractLogEvent; import com.sap.sailing.domain.abstractlog.race.RaceLog; import com.sap.sailing.domain.abstractlog.race.RaceLogEvent; import com.sap.sailing.domain.abstractlog.race.RaceLogRaceStatusEvent; +import com.sap.sailing.domain.base.CourseArea; +import com.sap.sailing.domain.base.Event; import com.sap.sailing.domain.base.Regatta; import com.sap.sailing.domain.base.Series; import com.sap.sailing.domain.common.CompetitorRegistrationType; +import com.sap.sailing.domain.common.Position; import com.sap.sailing.domain.common.RankingMetrics; import com.sap.sailing.domain.common.RegattaName; import com.sap.sailing.domain.common.dto.FleetDTO; @@ -26,9 +29,14 @@ import com.sap.sailing.domain.leaderboard.FlexibleLeaderboard; import com.sap.sailing.domain.leaderboard.impl.LowPoint; import com.sap.sailing.domain.racelog.RaceLogIdentifier; import com.sap.sailing.server.impl.RacingEventServiceImpl; +import com.sap.sailing.server.operationaltransformation.AddCourseAreas; import com.sap.sailing.server.operationaltransformation.AddSpecificRegatta; +import com.sap.sailing.server.operationaltransformation.CreateEvent; import com.sap.sailing.server.operationaltransformation.CreateFlexibleLeaderboard; import com.sap.sse.common.Color; +import com.sap.sse.common.Distance; +import com.sap.sse.common.Duration; +import com.sap.sse.common.TimePoint; import com.sap.sse.common.Util; public abstract class AbstractLogReplicationTest, EventT extends AbstractLogEvent, VisitorT> @@ -96,6 +104,16 @@ public abstract class AbstractLogReplicationTest seriesCreationParameters = new LinkedHashMap<>(); SeriesCreationParametersDTO creationParametersForDefaultSeries = new SeriesCreationParametersDTO( Arrays.asList(new FleetDTO[] { new FleetDTO(fleetName, 0, Color.BLACK), }), /* medal */ false, /* fleetsCanRunInParallel */ true, /* startsWithZero */ @@ -108,8 +126,7 @@ public abstract class AbstractLogReplicationTest { return new ConstructorParameters() { private final DomainFactory baseDomainFactory = new DomainFactoryImpl(raceLogResolver); - @Override public DomainObjectFactory getDomainObjectFactory() { return PersistenceFactory.INSTANCE.getDomainObjectFactory(mongoDBService, baseDomainFactory); } + @Override public DomainObjectFactory getDomainObjectFactory() { return PersistenceFactory.INSTANCE.getMajorityDomainObjectFactory(mongoDBService, baseDomainFactory); } @Override public MongoObjectFactory getMongoObjectFactory() { return mongoObjectFactory; } @Override public DomainFactory getBaseDomainFactory() { return baseDomainFactory; } @Override public CompetitorAndBoatStore getCompetitorAndBoatStore() { return getBaseDomainFactory().getCompetitorAndBoatStore(); } @@ -68,7 +68,7 @@ public abstract class AbstractServerReplicationTest extends com.sap.sse.replicat (final RaceLogAndTrackedRaceResolver raceLogResolver) -> { return new RacingEventServiceImpl.ConstructorParameters() { private final DomainObjectFactory domainObjectFactory = - PersistenceFactory.INSTANCE.getDomainObjectFactory(mongoDBService, + PersistenceFactory.INSTANCE.getMajorityDomainObjectFactory(mongoDBService, // replica gets its own base DomainFactory: new DomainFactoryImpl(raceLogResolver)); @Override public DomainObjectFactory getDomainObjectFactory() { return domainObjectFactory; } diff --git a/java/com.sap.sailing.server/src/com/sap/sailing/server/impl/RacingEventServiceImpl.java b/java/com.sap.sailing.server/src/com/sap/sailing/server/impl/RacingEventServiceImpl.java index aededa2f460..1cf524d8aeb 100644 --- a/java/com.sap.sailing.server/src/com/sap/sailing/server/impl/RacingEventServiceImpl.java +++ b/java/com.sap.sailing.server/src/com/sap/sailing/server/impl/RacingEventServiceImpl.java @@ -1879,12 +1879,12 @@ Replicator { if (useStartTimeInference && controlTrackingFromStartAndFinishTimes) { throw new IllegalArgumentException("Cannot set both of useStartTimeInference and controlTrackingFromStartAndFinishTimes to true"); } - com.sap.sse.common.Util.Pair regattaWithCreatedFlag = getOrCreateRegattaWithoutReplication( + final com.sap.sse.common.Util.Pair regattaWithCreatedFlag = getOrCreateRegattaWithoutReplication( fullRegattaName, boatClassName, canBoatsOfCompetitorsChangePerRace, competitorRegistrationType, registrationLinkSecret, startDate, endDate, id, series, persistent, scoringScheme, courseAreaIds, buoyZoneRadiusInHullLengths, useStartTimeInference, controlTrackingFromStartAndFinishTimes, autoRestartTrackingUponCompetitorSetChange, rankingMetricConstructor); - Regatta regatta = regattaWithCreatedFlag.getA(); + final Regatta regatta = regattaWithCreatedFlag.getA(); if (regattaWithCreatedFlag.getB()) { onRegattaLikeAdded(regatta); replicateSpecificRegattaWithoutRaceColumns(regatta); @@ -1916,13 +1916,13 @@ Replicator { ScoringScheme scoringScheme, Iterable courseAreaIds, Double buoyZoneRadiusInHullLengths, boolean useStartTimeInference, boolean controlTrackingFromStartAndFinishTimes, boolean autoRestartTrackingUponCompetitorSetChange, RankingMetricConstructor rankingMetricConstructor) { - Regatta regatta = new RegattaImpl(getRaceLogStore(), getRegattaLogStore(), fullRegattaName, + final Regatta regatta = new RegattaImpl(getRaceLogStore(), getRegattaLogStore(), fullRegattaName, getBaseDomainFactory().getOrCreateBoatClass(boatClassName), canBoatsOfCompetitorsChangePerRace, competitorRegistrationType, startDate, endDate, series, persistent, scoringScheme, id, Util.map(courseAreaIds, courseAreaId->getBaseDomainFactory().getExistingCourseAreaById(courseAreaId)), buoyZoneRadiusInHullLengths, useStartTimeInference, controlTrackingFromStartAndFinishTimes, autoRestartTrackingUponCompetitorSetChange, rankingMetricConstructor, registrationLinkSecret); - boolean wasCreated = addAndConnectRegatta(persistent, regatta); + final boolean wasCreated = addAndConnectRegatta(persistent, regatta); if (wasCreated) { logger.info("Created regatta " + regatta.getName() + " (" + hashCode() + ") on " + this); } diff --git a/java/com.sap.sailing.www/release_notes_admin.html b/java/com.sap.sailing.www/release_notes_admin.html index 2dfcfc5e79e..b6d64107c2d 100755 --- a/java/com.sap.sailing.www/release_notes_admin.html +++ b/java/com.sap.sailing.www/release_notes_admin.html @@ -23,6 +23,13 @@

    Release Notes - Administration Console

    +

    June 2024

    +
      +
    • Upgraded to TracAPI 3.15.8, supporting more TracTrac invalid result markers (IRMs), + in particular DCT, DNE, and RCT.
    • +
    • For raw data output of wind sensor and object positions, where permitted, use seven instead of + six decimal places in lat/lng output to increase resolution to approximately 1cm.
    • +

    May 2024

    • Reading the wind estimation data from a server during start-up, using the diff --git a/java/com.sap.sse.common/src/com/sap/sse/common/util/RoundingUtil.java b/java/com.sap.sse.common/src/com/sap/sse/common/util/RoundingUtil.java index bcef177ea65..b587cf62bab 100644 --- a/java/com.sap.sse.common/src/com/sap/sse/common/util/RoundingUtil.java +++ b/java/com.sap.sse.common/src/com/sap/sse/common/util/RoundingUtil.java @@ -6,7 +6,7 @@ public class RoundingUtil { public static final RoundingUtil knotsDecimalFormatter = new RoundingUtil(2); public static final RoundingUtil bearingDecimalFormatter = new RoundingUtil(1); public static final RoundingUtil speedDecimalFormatter = new RoundingUtil(1); - public static final RoundingUtil latLngDecimalFormatter = new RoundingUtil(6); + public static final RoundingUtil latLngDecimalFormatter = new RoundingUtil(7); private final double shiftFactor; diff --git a/java/com.sap.sse.replication.testsupport/src/com/sap/sse/replication/testsupport/AbstractServerReplicationTestSetUp.java b/java/com.sap.sse.replication.testsupport/src/com/sap/sse/replication/testsupport/AbstractServerReplicationTestSetUp.java index 301e7c2c10f..3018baee424 100644 --- a/java/com.sap.sse.replication.testsupport/src/com/sap/sse/replication/testsupport/AbstractServerReplicationTestSetUp.java +++ b/java/com.sap.sse.replication.testsupport/src/com/sap/sse/replication/testsupport/AbstractServerReplicationTestSetUp.java @@ -47,6 +47,7 @@ import com.sap.sse.replication.Replicable; import com.sap.sse.replication.ReplicationMasterDescriptor; import com.sap.sse.replication.ReplicationReceiver; import com.sap.sse.replication.ReplicationService; +import com.sap.sse.replication.ReplicationServletActions.Action; import com.sap.sse.replication.impl.Activator; import com.sap.sse.replication.impl.RabbitOutputStream; import com.sap.sse.replication.impl.ReplicationInstancesManager; @@ -367,17 +368,17 @@ public abstract class AbstractServerReplicationTestSetUp script that compiles the code in the src folder, creates the test.jar library and execute the code of the example. - Manifest.txt -> manifest used to create the test.jar file +******************************************** + TracAPI 3.15.8 +******************************************** +This is a final version. It keeps the backward compatibility. + + Release date: 06/06/2024 + + 1) Features + + - Adding new values to the RaceCompetitorStatusType: RCT(Retired after causing a tangle), + DCT(Disqualified after causing a tangle) and DNE(Disqualification not excludable). + (Requested by Radek Masnika, 30/05/2024) + - Adding the method IPosition.getHACC to retrieve the horizontal accuracy (Requested by Chris Terkelsen, + 05/05/2024) + ******************************************** TracAPI 3.15.7 ******************************************** diff --git a/java/com.tractrac.clientmodule/javadoc/allclasses-frame.html b/java/com.tractrac.clientmodule/javadoc/allclasses-frame.html index 1a429f9dcbb..5cd2d4386ee 100644 --- a/java/com.tractrac.clientmodule/javadoc/allclasses-frame.html +++ b/java/com.tractrac.clientmodule/javadoc/allclasses-frame.html @@ -2,10 +2,10 @@ - + -All Classes (Subscription - Applications - TracAPI 3.15.7 API) - +All Classes (Subscription - Applications - TracAPI 3.15.8 API) + diff --git a/java/com.tractrac.clientmodule/javadoc/allclasses-noframe.html b/java/com.tractrac.clientmodule/javadoc/allclasses-noframe.html index 6131472a992..d9c9a2b0f47 100644 --- a/java/com.tractrac.clientmodule/javadoc/allclasses-noframe.html +++ b/java/com.tractrac.clientmodule/javadoc/allclasses-noframe.html @@ -2,10 +2,10 @@ - + -All Classes (Subscription - Applications - TracAPI 3.15.7 API) - +All Classes (Subscription - Applications - TracAPI 3.15.8 API) + diff --git a/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/IIdentifiable.html b/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/IIdentifiable.html index 4591e218d42..04a387d163c 100644 --- a/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/IIdentifiable.html +++ b/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/IIdentifiable.html @@ -2,10 +2,10 @@ - + -IIdentifiable (Subscription - Applications - TracAPI 3.15.7 API) - +IIdentifiable (Subscription - Applications - TracAPI 3.15.8 API) + @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ diff --git a/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/attachment/package-summary.html b/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/attachment/package-summary.html index f38bf573fb2..53b8afe8627 100644 --- a/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/attachment/package-summary.html +++ b/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/attachment/package-summary.html @@ -2,10 +2,10 @@ - + -com.tractrac.model.lib.api.attachment (Subscription - Applications - TracAPI 3.15.7 API) - +com.tractrac.model.lib.api.attachment (Subscription - Applications - TracAPI 3.15.8 API) + @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,13 +13,13 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ diff --git a/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/data/package-summary.html b/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/data/package-summary.html index acc0b8f38d6..23eadf2d93c 100644 --- a/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/data/package-summary.html +++ b/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/data/package-summary.html @@ -2,10 +2,10 @@ - + -com.tractrac.model.lib.api.data (Subscription - Applications - TracAPI 3.15.7 API) - +com.tractrac.model.lib.api.data (Subscription - Applications - TracAPI 3.15.8 API) + @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ diff --git a/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/event/package-summary.html b/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/event/package-summary.html index 464da6a0e31..da6e13f66e2 100644 --- a/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/event/package-summary.html +++ b/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/event/package-summary.html @@ -2,10 +2,10 @@ - + -com.tractrac.model.lib.api.event (Subscription - Applications - TracAPI 3.15.7 API) - +com.tractrac.model.lib.api.event (Subscription - Applications - TracAPI 3.15.8 API) + @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ diff --git a/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/metadata/package-summary.html b/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/metadata/package-summary.html index 6a83c7db0d2..430960eb796 100644 --- a/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/metadata/package-summary.html +++ b/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/metadata/package-summary.html @@ -2,10 +2,10 @@ - + -com.tractrac.model.lib.api.metadata (Subscription - Applications - TracAPI 3.15.7 API) - +com.tractrac.model.lib.api.metadata (Subscription - Applications - TracAPI 3.15.8 API) + @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ diff --git a/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/package-summary.html b/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/package-summary.html index 502d20fc149..fba9592da8e 100644 --- a/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/package-summary.html +++ b/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/package-summary.html @@ -2,10 +2,10 @@ - + -com.tractrac.model.lib.api (Subscription - Applications - TracAPI 3.15.7 API) - +com.tractrac.model.lib.api (Subscription - Applications - TracAPI 3.15.8 API) + @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ diff --git a/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/route/package-summary.html b/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/route/package-summary.html index 91d7b95490c..ef6a9fc0a54 100644 --- a/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/route/package-summary.html +++ b/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/route/package-summary.html @@ -2,10 +2,10 @@ - + -com.tractrac.model.lib.api.route (Subscription - Applications - TracAPI 3.15.7 API) - +com.tractrac.model.lib.api.route (Subscription - Applications - TracAPI 3.15.8 API) + @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ diff --git a/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/sensor/package-summary.html b/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/sensor/package-summary.html index 6d9b318a0d2..54d0c218084 100644 --- a/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/sensor/package-summary.html +++ b/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/sensor/package-summary.html @@ -2,10 +2,10 @@ - + -com.tractrac.model.lib.api.sensor (Subscription - Applications - TracAPI 3.15.7 API) - +com.tractrac.model.lib.api.sensor (Subscription - Applications - TracAPI 3.15.8 API) + @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ diff --git a/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/spatial/package-summary.html b/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/spatial/package-summary.html index 703cbe2fd28..2e80d64a1b4 100644 --- a/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/spatial/package-summary.html +++ b/java/com.tractrac.clientmodule/javadoc/com/tractrac/model/lib/api/spatial/package-summary.html @@ -2,10 +2,10 @@ - + -com.tractrac.model.lib.api.spatial (Subscription - Applications - TracAPI 3.15.7 API) - +com.tractrac.model.lib.api.spatial (Subscription - Applications - TracAPI 3.15.8 API) + @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ diff --git a/java/com.tractrac.clientmodule/javadoc/com/tractrac/subscription/lib/api/competitor/package-summary.html b/java/com.tractrac.clientmodule/javadoc/com/tractrac/subscription/lib/api/competitor/package-summary.html index fddca636f86..c0e6bafa0fe 100644 --- a/java/com.tractrac.clientmodule/javadoc/com/tractrac/subscription/lib/api/competitor/package-summary.html +++ b/java/com.tractrac.clientmodule/javadoc/com/tractrac/subscription/lib/api/competitor/package-summary.html @@ -2,10 +2,10 @@ - + -com.tractrac.subscription.lib.api.competitor (Subscription - Applications - TracAPI 3.15.7 API) - +com.tractrac.subscription.lib.api.competitor (Subscription - Applications - TracAPI 3.15.8 API) + @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ diff --git a/java/com.tractrac.clientmodule/javadoc/com/tractrac/subscription/lib/api/control/package-summary.html b/java/com.tractrac.clientmodule/javadoc/com/tractrac/subscription/lib/api/control/package-summary.html index 23ed86b046b..4e19cbc1880 100644 --- a/java/com.tractrac.clientmodule/javadoc/com/tractrac/subscription/lib/api/control/package-summary.html +++ b/java/com.tractrac.clientmodule/javadoc/com/tractrac/subscription/lib/api/control/package-summary.html @@ -2,10 +2,10 @@ - + -com.tractrac.subscription.lib.api.control (Subscription - Applications - TracAPI 3.15.7 API) - +com.tractrac.subscription.lib.api.control (Subscription - Applications - TracAPI 3.15.8 API) + @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ diff --git a/java/com.tractrac.clientmodule/javadoc/com/tractrac/subscription/lib/api/event/package-summary.html b/java/com.tractrac.clientmodule/javadoc/com/tractrac/subscription/lib/api/event/package-summary.html index ee48383dfbf..48d63a69c96 100644 --- a/java/com.tractrac.clientmodule/javadoc/com/tractrac/subscription/lib/api/event/package-summary.html +++ b/java/com.tractrac.clientmodule/javadoc/com/tractrac/subscription/lib/api/event/package-summary.html @@ -2,10 +2,10 @@ - + -com.tractrac.subscription.lib.api.event (Subscription - Applications - TracAPI 3.15.7 API) - +com.tractrac.subscription.lib.api.event (Subscription - Applications - TracAPI 3.15.8 API) + @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ diff --git a/java/com.tractrac.clientmodule/javadoc/com/tractrac/subscription/lib/api/package-summary.html b/java/com.tractrac.clientmodule/javadoc/com/tractrac/subscription/lib/api/package-summary.html index 3e24dd397a3..60b3126713f 100644 --- a/java/com.tractrac.clientmodule/javadoc/com/tractrac/subscription/lib/api/package-summary.html +++ b/java/com.tractrac.clientmodule/javadoc/com/tractrac/subscription/lib/api/package-summary.html @@ -2,10 +2,10 @@ - + -com.tractrac.subscription.lib.api (Subscription - Applications - TracAPI 3.15.7 API) - +com.tractrac.subscription.lib.api (Subscription - Applications - TracAPI 3.15.8 API) + @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ diff --git a/java/com.tractrac.clientmodule/javadoc/com/tractrac/subscription/lib/api/race/package-summary.html b/java/com.tractrac.clientmodule/javadoc/com/tractrac/subscription/lib/api/race/package-summary.html index a9972433463..1ec8d45f0b4 100644 --- a/java/com.tractrac.clientmodule/javadoc/com/tractrac/subscription/lib/api/race/package-summary.html +++ b/java/com.tractrac.clientmodule/javadoc/com/tractrac/subscription/lib/api/race/package-summary.html @@ -2,10 +2,10 @@ - + -com.tractrac.subscription.lib.api.race (Subscription - Applications - TracAPI 3.15.7 API) - +com.tractrac.subscription.lib.api.race (Subscription - Applications - TracAPI 3.15.8 API) + @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ diff --git a/java/com.tractrac.clientmodule/javadoc/com/tractrac/subscription/lib/api/route/package-summary.html b/java/com.tractrac.clientmodule/javadoc/com/tractrac/subscription/lib/api/route/package-summary.html index 4942fdfcbb3..b8f46e8cb25 100644 --- a/java/com.tractrac.clientmodule/javadoc/com/tractrac/subscription/lib/api/route/package-summary.html +++ b/java/com.tractrac.clientmodule/javadoc/com/tractrac/subscription/lib/api/route/package-summary.html @@ -2,10 +2,10 @@ - + -com.tractrac.subscription.lib.api.route (Subscription - Applications - TracAPI 3.15.7 API) - +com.tractrac.subscription.lib.api.route (Subscription - Applications - TracAPI 3.15.8 API) + @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ diff --git a/java/com.tractrac.clientmodule/javadoc/overview-summary.html b/java/com.tractrac.clientmodule/javadoc/overview-summary.html index 5be896c3bf3..b761dfdd6ca 100644 --- a/java/com.tractrac.clientmodule/javadoc/overview-summary.html +++ b/java/com.tractrac.clientmodule/javadoc/overview-summary.html @@ -2,10 +2,10 @@ - + -Overview (Subscription - Applications - TracAPI 3.15.7 API) - +Overview (Subscription - Applications - TracAPI 3.15.8 API) + @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@