{"id":14988282,"url":"https://github.com/apache/jspwiki","last_synced_at":"2025-05-15T08:11:11.161Z","repository":{"id":531960,"uuid":"161005","full_name":"apache/jspwiki","owner":"apache","description":"Apache JSPWiki is a leading open source WikiWiki engine, feature-rich and built around standard JEE components (Java, servlets, JSP)","archived":false,"fork":false,"pushed_at":"2025-05-10T10:58:57.000Z","size":113218,"stargazers_count":108,"open_issues_count":10,"forks_count":101,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-05-10T11:31:09.140Z","etag":null,"topics":["apache","asf","content","java","jspwiki","wiki"],"latest_commit_sha":null,"homepage":"https://jspwiki.apache.org/","language":"Java","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apache.png","metadata":{"files":{"readme":"README.md","changelog":"ChangeLog.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2009-03-27T15:41:58.000Z","updated_at":"2025-05-10T10:57:46.000Z","dependencies_parsed_at":"2023-12-02T21:21:55.416Z","dependency_job_id":"f9b7e0c8-f395-4da1-be32-0afc7c6d5919","html_url":"https://github.com/apache/jspwiki","commit_stats":{"total_commits":9390,"total_committers":34,"mean_commits":276.1764705882353,"dds":0.4554845580404686,"last_synced_commit":"7bf6657511dfd7224dcabac2482f6171a21276f8"},"previous_names":[],"tags_count":113,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fjspwiki","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fjspwiki/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fjspwiki/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fjspwiki/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apache","download_url":"https://codeload.github.com/apache/jspwiki/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253858414,"owners_count":21974920,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apache","asf","content","java","jspwiki","wiki"],"created_at":"2024-09-24T14:16:24.813Z","updated_at":"2025-05-15T08:11:11.138Z","avatar_url":"https://github.com/apache.png","language":"Java","readme":"# Apache JSPWiki 2.12 - Documentation\n\n    Licensed to the Apache Software Foundation (ASF) under one\n    or more contributor license agreements.  See the NOTICE file\n    distributed with this work for additional information\n    regarding copyright ownership.  The ASF licenses this file\n    to you under the Apache License, Version 2.0 (the\n    \"License\"); you may not use this file except in compliance\n    with the License.  You may obtain a copy of the License at\n\n       https://www.apache.org/licenses/LICENSE-2.0\n\n    Unless required by applicable law or agreed to in writing,\n    software distributed under the License is distributed on an\n    \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n    KIND, either express or implied.  See the License for the\n    specific language governing permissions and limitations\n    under the License.  \n\nThe license file can be found in LICENSE.\n\n\n## What is JSPWiki?\n\nJSPWiki is a simple (well, not anymore) WikiWiki clone, written in Java\nand JSP.  A WikiWiki is a website which allows anyone to participate\nin its development.  JSPWiki supports all the traditional wiki features,\nas well as very detailed access control and security integration using JAAS. \n\n* For more information see https://jspwiki-wiki.apache.org/\n\n## Pre-requirements\n\nOkay, so you wanna Wiki?  You'll need the following things:\n\nREQUIRED:\n\n* A JSP engine that supports Servlet API 3.1.  We recommend [Apache Tomcat](https://tomcat.apache.org/)\n  for a really easy installation. Tomcat 9.x or later is recommended, although Tomcat 8.x \n  is supported too; see [additional configuration](https://jspwiki-wiki.apache.org/Wiki.jsp?page=Getting%20Started#section-Getting+Started-Tomcat8.x) \n  that must be set up in order to run JSPWiki on Tomcat 8.x.\n\n* Some previous administration experience...  If you've ever installed\n  Apache or any other web server, you should be pretty well off.\n\n* And of course, a server to run the JSP engine on.\n\n* JDK 11+\n\n\nOPTIONAL:\n\n* JavaMail package from java.sun.com, if you want to use log4j mailing\n  capabilities.  You'll also need the Java Activation Framework.\n\n## Really simple installation\n\nThis section is meant for you, if you just want to have a really quick\ninstall without many worries.  If you want to have a more complicated\ninstallation (with more power as to how to do things), \ncheck out the \"Install\" section below.\n\nSince JSPWiki 2.1.153, JSPWiki comes with a really simple installation\nengine.  Just do the following:\n\n1) Install Tomcat from https://tomcat.apache.org/ (or any other servlet\n   container)\n\n2) Rename the JSPWiki.war file from the download and rename it based on\n   your desired URL (if you want it different from /JSPWiki).  For example,\n   if you want your URL to be http://.../wiki, rename it to wiki.war.\n   This name will be referred to as \u003cappname\u003e below.\n   Place this WAR in your `$TOMCAT_HOME/webapps` folder and then start Tomcat.\n\n3) Point your browser at http://\u0026lt;myhost\u003e/\u0026lt;appname\u003e/Install.jsp\n\n4) Answer a couple of simple questions\n\n5) Restart your container\n\n6) Point your browser to http://\u0026lt;myhost\u003e/\u0026lt;appname\u003e/\n\nThat's it!\n\n## Advanced Installation\n\nIn the `$TOMCAT_HOME/lib` folder (or equivalent based on your servlet container),\nplace a `jspwiki-custom.properties` file, which can contain any overrides to the \ndefault `ini/jspwiki.properties` file in the JSPWiki JAR.  For any values not \nplaced in `jspwiki-custom.properties` file JSPWiki will rely on the default file.\nReview the default file to look for values you may wish to override in the custom\nfile.  Some common values to override in your custom file include \n`jspwiki.xmlUserDatabaseFile`, `jspwiki.xmlGroupDatabaseFile`, \n`jspwiki.fileSystemProvider.pageDir`, `jspwiki.basicAttachmentProvider.storageDir`, \nand `log4j.appender.FileLog.File`.  The comments in the default file will suggest \nappropriate values to override them with. \n\nThe custom file can also be placed in the `WEB-INF/` folder of the WAR, but storing\nthis file in `$TOMCAT_HOME/lib` allows you to upgrade the JSPWiki WAR without needing\nto re-insert your customizations.\n\nUnzip the contents of `jspwiki-corepages.zip` into your newly created\ndirectory.  You can find the rest of the documentation in the\n`JSPWiki-doc.zip` file.\n\n(Re)start tomcat.\n\nPoint your browser at http://\u0026lt;where your Tomcat is installed\u003e/MyWiki/.\nYou should see the Main Wiki page.  See the next section if you want\nto edit the pages =).\n\nThe `WEB-INF/jspwiki.policy` file is used to change access permissions for \nthe Wiki.\n\nCheck the Apache JSPWiki website and project documentation for additional\nsetup and configuration suggestions.\n\n## Using the Docker image\n\n_**Docker images are not official ASF releases but provided for convenience. \nRecommended usage is always to build the source.**_\n\nThe Apache JSPWiki Docker image is available at [Docker Hub](https://registry.hub.docker.com/r/apache/jspwiki/).\n\n### Get the Image\n```\n$ docker pull apache/jspwiki\n```\n\n### Running the Container\n```\n$ docker run -d -p 8080:8080 --name jspwiki apache/jspwiki\n```\n\nThen point your browser at http://localhost:8080/, that should give you a working \nwiki right away!\n\nSee https://jspwiki-wiki.apache.org/Wiki.jsp?page=Docker for customizations and \nadvanced usage of the image.\n\n## Upgrading from previous versions\n\nPlease read [ReleaseNotes](./ReleaseNotes) and the [UPGRADING](./UPGRADING) documents available with this\ndistribution.\n\n## Contact\n\nQuestions can be asked to JSPWiki team members and fellow users via the jspwiki-users\nmailing list: See https://jspwiki.apache.org/community/mailing_lists.html.\nPlease use the user mailing list instead of contacting team members directly, \nand as this is a public list stored in public archives, be sure to avoid including\nany sensitive information (passwords, data, etc.) in your questions.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fjspwiki","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapache%2Fjspwiki","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fjspwiki/lists"}