Skip to content

Commit

Permalink
Fix headers so that the toc appears correctly
Browse files Browse the repository at this point in the history
  • Loading branch information
fxthomas committed Apr 15, 2020
1 parent 59385ec commit e380fe3
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 15 deletions.
5 changes: 3 additions & 2 deletions captcha/captcha.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ layout: docs
title: CAPTCHA
permalink: /docs/captcha/
---

Airsonic supports requiring anybody attempting to reset a user's password to
solve a [CAPTCHA](https://en.wikipedia.org/wiki/CAPTCHA), making it more
difficult for attackers to automatically cause passwords to be reset. Versions
Expand All @@ -13,7 +14,7 @@ reset their passwords).
The new CAPTCHA support is disabled by default because it requires additional
configuration. This documentation will walk through the process.

## Configuring
### Configuring

The settings controlling CAPTCHA use can be found in the advanced settings pane
of the Airsonic web interface.
Expand Down Expand Up @@ -43,7 +44,7 @@ Copy these into the Airsonic settings; the other information for client and
server-side integration is unnecessary because Airsonic already implements those
integrations.

## Testing
### Testing

It is possible to test CAPTCHA configuration by logging out of Airsonic and
selecting "Forgotten your password?" on the login page. If the CAPTCHA is
Expand Down
18 changes: 8 additions & 10 deletions developer/maven.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The following page explains how Maven is structured for Airsonic, including
many useful commands. Java IDE such as IntelliJ can run a subset of Maven
features, though some are only available on the command-line.

# Building Airsonic
### Building Airsonic

The following command can be used to build the Airsonic WAR package (`airsonic.war`):

Expand All @@ -39,29 +39,27 @@ Commands can also be combined, such as:
$ mvn -P integration-test clean verify
```

# Configuration
### Configuration

Maven's main configuration is split into multiple `pom.xml` files, starting
from the one at the root of the repository.

# Features

## WAR packaging
#### WAR packaging

The main Airsonic package is an executable Spring Boot WAR file
(`airsonic.war`), that can be both run in standalone mode or deployed on a
servlet container (such as Tomcat).

This is provided by `spring-boot-maven-plugin` in `airsonic-main/pom.xml`.

## Checkstyle
#### Checkstyle

The Maven build runs a "style checker", which checks the Airsonic code for
common issues or style inconsistencies.

This is provided by `maven-checkstyle-plugin`, defined in `pom.xml`.

## Dependency checker
#### Dependency checker

The Maven build runs the Dependency Checker plugin, which checks the Airsonic
code for security issues (CVE) or common dependency resolution errors (missing
Expand All @@ -75,7 +73,7 @@ $ mvn package -Ddependency-check.skip=true

This is provided by `dependency-check-maven`, defined in `pom.xml`.

## Unit tests (Maven Surefire)
#### Unit tests (Maven Surefire)

Airsonic unit tests are run using the Maven Surefire plugin.

Expand Down Expand Up @@ -103,7 +101,7 @@ or any such packaging. So your unit tests run directly on the compiled classes
in their loose individual forms (`*.class` files usually sitting in
`target/generated` or `target/classes` and `target/test-classes`).

## Integration tests (Maven Failsafe)
#### Integration tests (Maven Failsafe)

Airsonic unit tests are run using the Maven Failsafe plugin in a Docker container.

Expand Down Expand Up @@ -140,7 +138,7 @@ Finally it is important to note that just running the integration-test phase is
useless. You need to run verify because running the tests by itself doesn't do
much. You need to verify whether the tests passed or not.

## Other commands
#### Other commands

List all dependencies (useful for checking conflicts on upgrades):

Expand Down
6 changes: 3 additions & 3 deletions developer/performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Performance tests
permalink: /docs/developer/performance/
---

# Metrics
### Metrics

The Airsonic framework contains a convenient class (called MetricsManager) to add inner metrics that constructs in real time some performance indicators.

Expand All @@ -24,12 +24,12 @@ Each metric is registered as a MBean as shown below.

![](metrics-visualvm-screenshot.png)

# Apache JMeter
### Apache JMeter

This document explains how to run performance tests on Airsonic using [Apache JMeter](http://jmeter.apache.org/).
The installation and setup of JMeter is not documented bellow; please refer to the JMeter web site.

## Main test plan
#### Main test plan

The Airsonic sources come with a main performance test case defined in file airsonic-main/src/test/resources/jmeter/airsonicMainTestPlan.jmx.
This is a JMeter test plan file.
Expand Down

0 comments on commit e380fe3

Please sign in to comment.