@@ -10,7 +10,7 @@ Official project page is at [https://github.com/pwm-project/pwm/](https://github
* [Current Builds](https://www.pwm-project.org/artifacts/pwm/) - Current downloads built from recent github project commits
* [PWM Reference](https://www.pwm-project.org/pwm/public/reference/) - Reference documentation built into PWM.
-Features
+# Features
* Web based configuration manager with over 400 configurable settings
* Configurable display values for every user-facing text string
* Localized for Chinese (中文), Czech (ceština), Dutch (Nederlands), English, Finnish (suomi), French (français), German (Deutsch), Hebrew (עברית), Italian (italiano), Japanese (日本語), Korean (한국어), Polish (polski), Portuguese (português), Slovak (Slovenčina), Spanish (español), Thai (ไทย) and Turkish (Türkçe)
@@ -47,3 +47,62 @@ Features
* OpenLDAP
[NetIQ SSPR](https://www.netiq.com/products/self-service-password-reset/) is a commercial, supported self service password reset product based on PWM.
+
+# Build Information
+
+Build pre-requisites:
+* Java 1.8 JDK or newer
+* Maven 3.2 or newer
+
+Build execution:
+* Set `JAVA_HOME` environment variable to JDK home
+* Run `mvn clean package` in base directory
+
+A WAR file suitable for deployment on Apache Tomcat is created in `webapp/target` directory. Rename to `pwm.war` and copy into `tomcat/webapp` directory.
+
+Alternatively, an executable JAR file is created in `onejar\target`. This JAR file is self-contained single executable with embedded Apache Tomcat runtime. To execute use a command similar to:
+
+`java -jar pwm-onejar.jar`
+
+The executable will show additional options that may be required.
+
+A docker image is created in `docker/target` as jib-image.tar. You can import this docker image using a command similar to:
+
+`docker load --input=jib-image.tar`
+
+Create docker container and run using:
+`docker run -d --name <container name> -p 8443:8443 pwm/pwm-webapp`
+
+This will expose the https port to 8443. If you want the configuration to persist to you can also exposed configuration volume of `/config` using the docker `-v` option during the container
+creation and map it to a directory on the docker host or use a docker volume container.
+The PWM docker container will place all of it's configuration and runtime data in the `/config` volume.
+
+
+# PWM Source Code License Update Plan for 2019
+
+* Current License: GPL v2.0
+* New License: Apache 2.0
+* Notice Date: October 1, 2018
+* Update Date: February 1, 2019.
+
+The existing project is licensed using GPL v2.0 License
+(https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html). On or about the update date,
+the codebase will be updated as Apache 2.0 License (https://www.apache.org/licenses/LICENSE-2.0).
+This change is being made to allow commercial organizations a more friendly license structure.
+
+This will not change the nature or availability of the PWM Project. The development and open-source
+nature of PWM will continue as before. Existing, published PWM source code will continue to be
+available under the GPL v2.0 License, however all new development after the license date will only
+be published using the new license type.
+
+At the time of the license update, the existing source code will be branched and the code source
+will be archived and published under the existing GPL v2.0 license terms in perpetuity.
+
+Process:
+* This notice is posted publicly
+* Known contributors are sent this notice using last known address
+* Any objections or concerns by contributors will be processed as appropriate
+* On or about the update date:
+ * The existing code is branched and the GPL version will remain available
+ * License headers and notices will be updated to the new license type
+ * New development and contributions will be done under the new license type
"Display_HelpdeskOtpValidation": "Instruct the user to load their mobile authentication app and share the current pass code.",
+ "Display_InvalidVerification": "Viewing details only available after a user has been successfully verified",
"Display_MatchCondition": "Match Condition",
+ "Display_NoResponses": "User does not have responses",
"Display_PasswordGeneration": "The following passwords have been randomly generated for you. These passwords are based on real words to make them easier to remember, but have been modified to make them difficult to guess.",
"Display_PasswordPrompt": "Please type your new password",
"Display_PleaseWait": "Loading...",
"Display_Random": "Random",
"Display_SearchResultsExceeded": "Search results exceeded maximum search size",
"Display_SearchResultsNone": "No results",
+ "Display_SearchAttrsUnique": "Search attributes must be unique",
"Display_SetRandomPasswordPrompt": "Set a new random password for this user?",
"Display_StrengthMeter": "Password Strength",
"Display_TokenDestination": "Token Destination",
+ "Display_ViewDetails": "View Details",
+ "Display_EmailPrefix": "Email - ",
+ "Display_SmsPrefix": "SMS - ",
+ "Display_PeopleSearch": "Please type your search query below. You may search for a person based on name, email address or telephone number.",
"Field_DateTime": "Date/Time",
"Field_Display": "Display",
"Field_LdapProfile": "LDAP Profile",
@@ -41,16 +58,21 @@
"Field_Profile": "Profile",
"Field_Username": "User Name",
"Long_Title_VerificationSend": "Before this user can be selected, the user's identity must be verified. Please select a verification method.",
+ "Instructions_ExportOrgChart1": "Click the Export button to begin download of the organizational chart data. After download is complete, you can import the data into a program like Visio so it can be formatted into the desired output.",
+ "Instructions_ExportOrgChart2": "Choose the export level depth, and press the Export button below.",
+ "Instructions_EmailTeam1": "The email list is generated based off of organizational data starting at this point. When you click the Send Email button, your default email program should automatically open, with the list of email addresses pre-filled.",
+ "Instructions_EmailTeam2": "Choose the team level depth, and press the Email button below.",