Mirror of Apache Shiro Site
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
2010
2011
2012
2013/05/30
assets
shiro-web
static
templates
.gitignore
.htaccess
10-minute-tutorial.md.vtl
README.md
about.md
adoption.md
architecture.md.vtl
articles.md
authentication-features.md
authentication-guide.html.vtl
authentication.md.vtl
authenticator.html.vtl
authorization-features.md
authorization.md.vtl
authorizer.html.vtl
banner.html.vtl
cachemanager.md
caching.md
cas.md.vtl
codec.html.vtl
command-line-hasher.md
commercial-support.md
community.md
concurrency.md
conferences.md
config.scms.groovy
configuration.md.vtl
confluence-auto-export.html.vtl
contribute.md
core.md
cryptography-features.md
cryptography.md
deprecated-pages.html
developer-resources.md.vtl
developers.md
documentation-help-block.md
documentation.md.vtl
download.html.vtl
events.md
features-overview.md
features.md
forums.md
get-started.md
getting-started-block.md
graduation-resolution.md
guice.md.vtl
guides.md
how-to-contribute.md
inclusionslibrary.md
index.html
integration.md
introduction.md
issues.md
java-annotations-list.md
java-annotations.md
java-authentication-guide.md.vtl
java-authorization-guide.md.vtl
java-cryptography-guide.md.vtl
jaxrs.md.vtl
jsp-tag-library.md
license.md
mailing-lists.md.vtl
navigation.md
news.html
overview.md
performing-a-release.html.vtl
permissions.md
powered-by-shiro.md
privacy-policy.md
quickstart.html.vtl
realm.md.vtl
reference.md
security-reports.md
securitymanager.md.vtl
session-management-features.md
session-management.md.vtl
sessionmanager.html.vtl
site.xml
spring-boot.md.vtl
spring-framework.md.vtl
spring-xml.md
spring.md
subject.md.vtl
support.md
tags.html
team.md
terminology.md
testing.md.vtl
tools.md
tutorial.md.vtl
version-2-brainstorming.md
web-features.md
web.md.vtl
webapp-tutorial.md
what-is-shiro.md
wiki-todos.md

README.md

Apache Shiro Website Overview

The Apache Shiro website is a static content website accessible at http://shiro.apache.org

Site content is authored as Markdown and HTML files. These files are scanned by a tool that applies a page template to each file's contents as necessary, and the rendered static .html files are output to a publish directory.

Publishing site changes is as simple as committing any changes in the publish directory to version control. ASF infrastructure will see the commit and automatically push the changes to the ASF's production webservers.

Generating and Publishing

The tool used to generate the static content is SCMS. Once scms is installed and in your $PATH, generating and publishing the site on the command line is easy.

The following example assumes you have SVN commit permissions to the publish directory, typically because your are an Apache Shiro project committer:

cd site
# This next command will take a few seconds, be patient :)
scms trunk publish
# Open up the local publish/index.html file in your web browser.  Ensure the changes reflect what you want. 
#
# This next commands will publish changes to live ASF web servers.  Be confident the changes are what you want:
svn add .
svn commit -m "my change description"