removed old source and cleaned up some info files
Project: http://git-wip-us.apache.org/repos/asf/incubator-wave/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-wave/commit/4c37cd2e Tree: http://git-wip-us.apache.org/repos/asf/incubator-wave/tree/4c37cd2e Diff: http://git-wip-us.apache.org/repos/asf/incubator-wave/diff/4c37cd2e Branch: refs/heads/wavy Commit: 4c37cd2e1fa543c3eaeb679863eda2fa314e7c97 Parents: fa6f88f Author: wisebaldone <wisebald...@apache.org> Authored: Wed Apr 27 20:13:15 2016 +1000 Committer: wisebaldone <wisebald...@apache.org> Committed: Wed Apr 27 20:13:15 2016 +1000 ---------------------------------------------------------------------- LICENSE | 33 - NOTICE | 2 +- README.md | 245 +--- THANKS | 15 +- client/README.md | 15 + client/web/README.md | 10 +- editor/CHANGES | 2 +- editor/README.md | 13 +- server/CHANGES | 2789 +-------------------------------------------- server/README.md | 15 + server/THANKS | 12 +- website/README.md | 15 + 12 files changed, 98 insertions(+), 3068 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-wave/blob/4c37cd2e/LICENSE ---------------------------------------------------------------------- diff --git a/LICENSE b/LICENSE index 6bf7059..04ae24b 100644 --- a/LICENSE +++ b/LICENSE @@ -199,36 +199,3 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - -***THE FOLLOWING LICENSE APPLIES TO*** -- Protobuf Descriptors located at /src/google/protobuf/descriptor.proto - -Protocol Buffers - Google's data interchange format -Copyright 2008 Google Inc. All rights reserved. -http://code.google.com/p/protobuf/ - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are -met: - - * Redistributions of source code must retain the above copyright -notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above -copyright notice, this list of conditions and the following disclaimer -in the documentation and/or other materials provided with the -distribution. - * Neither the name of Google Inc. nor the names of its -contributors may be used to endorse or promote products derived from -this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE http://git-wip-us.apache.org/repos/asf/incubator-wave/blob/4c37cd2e/NOTICE ---------------------------------------------------------------------- diff --git a/NOTICE b/NOTICE index 51da160..28cf87f 100644 --- a/NOTICE +++ b/NOTICE @@ -1,5 +1,5 @@ Apache Wave - Copyright 2011-2014 The Apache Software Foundation + Copyright 2011-2016 The Apache Software Foundation This product includes software developed at The Apache Software Foundation (http://www.apache.org/). http://git-wip-us.apache.org/repos/asf/incubator-wave/blob/4c37cd2e/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index b33916a..dc1f6cc 100644 --- a/README.md +++ b/README.md @@ -3,234 +3,47 @@ | Jenkins | [](https://builds.apache.org/job/wave-small_tests) | | Travis | [](https://travis-ci.org/apache/incubator-wave) | -# Apache Wave +#  Apache Wave + +The Apache Wave project is a stand alone wave server and rich web editor and +multiple platform clients that serves as a Wave reference implementation. -The Apache Wave project is a stand alone wave server and rich web client -that serves as a Wave reference implementation. -Apache Wave site: http://incubator.apache.org/wave/. This project lets developers and enterprise users run wave servers and host waves on their own hardware. And then share those waves with other -wave servers. - -## Cryptographic Software Notice - -This distribution includes cryptographic software. The country in -which you currently reside may have restrictions on the import, -possession, use, and/or re-export to another country, of -encryption software. BEFORE using any encryption software, please -check your country's laws, regulations and policies concerning the -import, possession, or use, and re-export of encryption software, to -see if this is permitted. See <http://www.wassenaar.org/> for more -information. - -The U.S. Government Department of Commerce, Bureau of Industry and -Security (BIS), has classified this software as Export Commodity -Control Number (ECCN) 5D002.C.1, which includes information security -software using or performing cryptographic functions with asymmetric -algorithms. The form and manner of this Apache Software Foundation -distribution makes it eligible for export under the License Exception -ENC Technology Software Unrestricted (TSU) exception (see the BIS -Export Administration Regulations, Section 740.13) for both object -code and source code. - -The following provides more details on the included cryptographic -software: - - Wave requires the BouncyCastle Java cryptography APIs: - http://www.bouncycastle.org/java.html - -## Run Binary - -The nightly binaries can be downloaded from https://builds.apache.org/view/S-Z/view/Wave/job/wave-artifacts/lastSuccessfulBuild/artifact/. -The latest "dev" releases can be downloaded from: https://dist.apache.org/repos/dist/dev/incubator/wave/. -The latest officially released binaries can be downloaded from: https://dist.apache.org/repos/dist/release/incubator/wave/. -Extract the archive and execute run-server.sh for Linux/Mac or run-server.bat for Windows. -The web client will be accessible by default at http://localhost:9898/. - -## Setup with Vagrant - -A vagrant setup has been provided for automatic compile on a Ubuntu or Fedora -linux box. A windows box is also provided for testing but only installs requirements, -compilation and setup of the server require manual setup. - -Note: - -- requires vagrant and virtual box to be installed and an internet -connection. -- these images use jdk v8 which isn't officially supported but is used to test -for future compatibility. - -### Ubuntu & Fedora ( recommended ) - -running `vagrant up ubuntu` or `vagrant up fedora` will create a linux box -where the project will be compiled and dist installed to `/opt/apache/wave`. In -this folder you can find the current dist source and run the server. A server -config file has been provided to allow the server to be accessible outside the -vm listening on `0.0.0.0:9898`. - -To update the dist just run `vagrant up linux` where linux is either ubuntu or -fedora. - -note: -`vagrant ssh linux` where linux is either ubuntu or fedora can be used for a -ssh session. - -### Windows 10 (requires vagrant 1.8+) - -running `vagrant up win10` will setup a windows 10 environment for Apache Wave, -this vm does not setup a dist but that can be done by following the steps below -in the Gradle Tasks section within the vm. - -The virtual machine will make a copy of the current source into the users -documents folder under Apache-Wave. Running the vagrant up command again will -update this folder. The standard config for vagrant testing can be located at -`scripts/vagrant/application.conf`, just copy this file to the location -of the distributions config folder. - -### Note - -These vagrant setups are not production use and should not be used as such. - -## Setup Dev - -Apache Wave can be setup for eclipse and intellij IDE's. - -Running `./gradlew eclipse` or `./gradlew idea` will generate all project files needed. -In a situation where dependencies have changed or project structure has changed -run `./gradlew cleanEclipse` or `./gradlew cleanIdea` depending on your IDE. - - -## Gradle Tasks - -Apache Wave requires Java 7 & Gradle 2.8+ to build. - -Gradle tasks can be run by `./gradlew [task name]` - -Test Tasks: - -- **test**: runs the standard unit tests. -- **testMongo**: runs the mongodb tests. -- **testLarge**: runs the more lengthy test cases. -- **testGwt**: runs gwt specific tests (currently broken till gwt jetty conflict issue). -- **testAll**: runs all the above tests. - -Compile Tasks: - -- **generateMessages**: Generates the message source files from the .st sources. -- **generateGXP**: Compiles sources from the gxp files. -- **compileJava**: Compiles all java sources. -- **compileGwt**: Compiles all the Gwt sources. -- **compileGwtDemo**: Compiles all the Gwt sources in Demo style. -- **compileGwtDev**: Compiles all the Gwt sources in Dev style. - -Check Tasks: - -- **rat**: will run the apache rat tool to check all distribution files. - -Run Tasks: - -- **run**: runs the server with the default parameters and with gwt compiled normally. -- **gwtDev**: runs the gwt development mode. - -Distribution Tasks: -- **jar**: builds jar file for the project. -- **sourcesJar**: builds a source jar file for each project. -- **createDist**: builds the zip and tar file for bin and source. -- **createDistBin**: builds the zip for distribution. -- **createDistBinZip**: builds the zip for distribution. -- **createDistBinTar**: builds the tar for distribution. -- **createDistSource**: builds the zip and tar file for distributing the source. -- **createDistSourceZip**: builds the zip for distributing the source. -- **createDistSourceTar**: builds the tar for distributing the source. - - -## Build - -To build the client and server: - `./gradlew jar` -It will be created in wave/build/libs/wave-*version*.jar - -The sources can also be packaged into a jar by doing - `./gradlew sourcesJar` -This will create a `project name`-sources.jar in each projects build/libs directory. - -Note: - -- if pst-`version`.jar is unable to be found run `./gradlew pst:jar` then retry. -- if a jar is unable to be unzipped with wave:extractApi then delete the jar from your cache and try again. - You may need to restart. If problem persists let the newsgroup know or create an issue on Jira. - -To config your server a default configuration is provided by reference.conf, -this can be overwritten by application.conf with custom values. - -To enable federation the following must be run. - -To create a simple configuration run: - `./gradlew prosody-config` - -To override default values pass them to the ant script. -For example, to override wave\_server\_domain run: -`./gradlew prosody-config -Dwave_server_domain=example.com` -Take a look at the reference.conf to learn about configuration and possible/default values. - -The server can be started (on Linux/MacOS) by running - ./run-server.sh -Or on Windows by running - run-server.bat - Note: must be cd'ed into the root directory -Or, you can run the server from the compiled classes with Gradle: - gradle run -The web client will be accessible by default at http://localhost:9898/. - - -## To learn more about Wave in a Box and Wave Federation Protocol: - -1. Subscribe to the wave-dev mailing list, find instructions at http://incubator.apache.org/wave/mailing-lists.html. -2. Visit the Apache Wave wiki at https://cwiki.apache.org/confluence/display/WAVE/Home. -3. Look at the white papers folder - the information is a bit old but still usable. -4. Watch the Wave Summit videos on YouTube, find the links at: https://cwiki.apache.org/confluence/display/WAVE/Wave+Summit+Talks - - -## To enable SSL: +wave servers through federation. -Create a Java keystore for your server (e.g. using http://portecle.sourceforge.net/). -You will need a key (e.g. called "server") whose subject Common Name (CN) is -the hostname of your server. +The Apache Wave project is a distributed, near-real-time, rich collaboration +platform that allows users to work together in new and exciting ways. Wave +allows for flexible modes of communication, blending chat, email and +collaborative document editing in to one seamless environment. Wave provides a +lively and responsive environment that promotes more fluid and dynamic +collaboration between users. -Set enable_ssl = true and set the ssl_keystore_path and ssl_keystore_password options. +## Resources +| Homepage | http://incubator.apache.org/wave/ | +| Mailing list | http://incubator.apache.org/wave/mailing-lists.html | +| Hipchat | https://www.hipchat.com/gsModF8CY | +| Jira | https://issues.apache.org/jira/browse/WAVE/ | +| Wiki | https://cwiki.apache.org/confluence/display/WAVE/Home | +| Binaries - Offical | https://dist.apache.org/repos/dist/release/incubator/wave/ | +| Binaries - Dev | https://dist.apache.org/repos/dist/dev/incubator/wave/ | +| Binaries - Nightly | https://builds.apache.org/view/S-Z/view/Wave/job/wave-artifacts/lastSuccessfulBuild/artifact/ | -To enable X.509 client authentication: +## Documentation -If your users have X.509 certificates which include their email address, you can have -them logged in automatically (with their wave ID being the same as their email address): -You can get X.509 certificates issued from any normal CA (e.g. StartSSL offer them for free). -You can get your CA's certficate from their website, though note they might provide more than 1 certificate which you need to chain before your client certificates are considered trusted. +## Getting started -1. Add the signing CA to your keystore file. -2. Set enable_clientauth = true -3. Set clientauth_cert_domain (to the part after the "@" in your email addresses). -4. (optional) Set disable_loginpage = true to prevent password-based logins. +### Requirements -Users will be automatically logged in when they access the site, with the -username taken from the email address in their certificate. +For dev requirements please see the individual projects. -Setting up third party optional dependencies: +For release requirments please see the list below: -## To enable MongoDB: +#### Server -In order to specify MongoDB in server.config as the storage option for storing deltas, accounts and attachments - you need to install according to instructions at: http://www.mongodb.org/downloads. -Or on Ubuntu Linux you can use the following command: - sudo apt-get install mongodb-org +#### Client -## To enable Solr (Currently Disabled): +#### Editor -In order to specify Solr in server.config as the search type - you need to install Solr according to instructions at: http://www.apache.org/dyn/closer.cgi/lucene/solr/4.9.1. -Or, you can use built in Ant script, i.e. run: - ant get-third-party-solr-dep -This will download and unzip the Solr distribution into third_party/solr folder. -You can then run the Solr server with: - run-solr.sh -for Linux/Mac or: - run-solr.bat -for Windows. +## Contributing http://git-wip-us.apache.org/repos/asf/incubator-wave/blob/4c37cd2e/THANKS ---------------------------------------------------------------------- diff --git a/THANKS b/THANKS index 8a9b0ae..2d440b8 100644 --- a/THANKS +++ b/THANKS @@ -6,12 +6,9 @@ required to be attributed, it is always nice to do so. As such, many thanks are given to the following projects which are used by Apache Wave, and have yet to be acknowledged. -Apache Ant -Apache Velocity -The EMMA Project -The Antlr Project -The cglib Project -The GWT Project -The OW2 Consortium (ASM) -The Hamcrest Project -The Tango Desktop Project +Please note these projects are not included in the distrubtion but allow the +project to be built and packaged. + +- Jenkins Project (https://jenkins.io/) +- Travis CI (https://travis-ci.org/) +- Bazel (http://bazel.io/) http://git-wip-us.apache.org/repos/asf/incubator-wave/blob/4c37cd2e/client/README.md ---------------------------------------------------------------------- diff --git a/client/README.md b/client/README.md index e69de29..4c75209 100644 --- a/client/README.md +++ b/client/README.md @@ -0,0 +1,15 @@ +# Apache Wave Clients + +This is the home of the Apache Wave clients, for more info on the clients see the individual readme's + +## Dev Install + +please see the individual readme's in the sub folders below. + +## Build Tasks + +please see the individual readme's in the sub folders below. + +## More Info + +link to relevant info for finding out more (website, cwiki, other) \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-wave/blob/4c37cd2e/client/web/README.md ---------------------------------------------------------------------- diff --git a/client/web/README.md b/client/web/README.md index aaf9719..fef5e57 100644 --- a/client/web/README.md +++ b/client/web/README.md @@ -1,15 +1,15 @@ -# Apache Wave Website +# Apache Wave Web Client -This is the home of the Apache Wave website. The website is made with Middleman and .... (blurb) +This is the home of the Apache Wave web client. ## Dev Install -list instructions on how to install pre requirements for the website +list instructions on how to install pre requirements for the web client. ## Build Tasks -what bazel commands to run to build, run, test the website +what bazel commands to run to build, run, test the web client. ## More Info -link to relevant info for finding out more (website, cwiki, other) \ No newline at end of file +link to relevant info for finding out more (website, cwiki, other) http://git-wip-us.apache.org/repos/asf/incubator-wave/blob/4c37cd2e/editor/CHANGES ---------------------------------------------------------------------- diff --git a/editor/CHANGES b/editor/CHANGES index 4ca0cdb..b2cef8b 100644 --- a/editor/CHANGES +++ b/editor/CHANGES @@ -1,3 +1,3 @@ -Summary since 0.5.0 +Summary since 0.0.1 ====================== - .... \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-wave/blob/4c37cd2e/editor/README.md ---------------------------------------------------------------------- diff --git a/editor/README.md b/editor/README.md index db89aea..20194d4 100644 --- a/editor/README.md +++ b/editor/README.md @@ -1,14 +1,17 @@ -# Apache Wave Server +# Apache Wave Editor -This is the home of the Apache Wave server. The server is written in golang and .... (blurb) +This is the home of the Apache Wave editor. The Apache Wave editor is a sub-project of Apache Wave to +provide an efficient rich text editor that can handle multiple clients. The editor has been influenced by +the Ace Editor and work done by Github with the atom editor. The editor takes advantage of the React library +for optimised rendering and Typescript to provide enhanced type safety and program structure. -## Dev Install +## Dev Requirements -list instructions on how to install pre requirements for the server +list instructions on how to install pre requirements for the editor. ## Build Tasks -what bazel commands to run to build, run, test the server +what bazel commands to run to build, run, test the editor. ## More Info
