Repository: incubator-toree-website Updated Branches: refs/heads/OverhaulSite 9c556c53e -> 26fb60dea
Added configuration options for Toree Project: http://git-wip-us.apache.org/repos/asf/incubator-toree-website/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-toree-website/commit/26fb60de Tree: http://git-wip-us.apache.org/repos/asf/incubator-toree-website/tree/26fb60de Diff: http://git-wip-us.apache.org/repos/asf/incubator-toree-website/diff/26fb60de Branch: refs/heads/OverhaulSite Commit: 26fb60dea7a0e0de7f42c62427ad8b1767a6352a Parents: 9c556c5 Author: Gino Bustelo <lbust...@us.ibm.com> Authored: Mon Jun 13 17:11:11 2016 -0500 Committer: Gino Bustelo <lbust...@us.ibm.com> Committed: Mon Jun 13 17:11:11 2016 -0500 ---------------------------------------------------------------------- documentation/user/installation.md | 44 ++++++++++++++++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-toree-website/blob/26fb60de/documentation/user/installation.md ---------------------------------------------------------------------- diff --git a/documentation/user/installation.md b/documentation/user/installation.md index 5a9096c..e2df8ad 100644 --- a/documentation/user/installation.md +++ b/documentation/user/installation.md @@ -80,7 +80,9 @@ on full configurables, see '--help-all'. # Configuring Spark -There are two options for setting configuration options for Spark. +Toree is started using the `spark-submit` script. All configuration options from Spark are consistent with configuring +a [Spark Submit](http://spark.apache.org/docs/latest/submitting-applications.html) job. There are two ways of +setting configuration options for Spark. The first is at install time with the `--spark_opts` command line option. @@ -97,6 +99,46 @@ SPARK_OPTS='--master=local[4]' jupyter notebook __Note:__ There is an order of precedence to the configuration options. `SPARK_OPTS` will overwrite any values configured in `--spark_opts`. +# Configuring Toree + +There are some configuration options that are specific to Toree. + +``` +Option Description +------ ----------- +--default-interpreter default interpreter for the kernel +--default-repositories comma seperated list of additional + repositories to resolve +--default-repository-credentials comma seperated list of credential + files to use +-h, --help display help information +--interpreter-plugin ip used to bind sockets +--jar-dir directory where user added jars are + stored (MUST EXIST) +--magic-url path to a magic jar +--max-interpreter-threads <Integer> total number of worker threads to use + to execute code +--nosparkcontext kernel should not create a spark context +-v, --version display version information +``` + +There are two way of setting these configuration options. + +The first is at install time with the `--toree_opts` command line option. + +``` +jupyter toree instal --toree_opts='--nosparkcontext' +``` + +The second option is configured at run time through the `TOREE_OPTS` environment variable. + +``` +TOREE_OPTS='--nosparkcontext' jupyter notebook +``` + +__Note:__ There is an order of precedence to the configuration options. `TOREE_OPTS` will overwrite any values configured in `--toree_opts`. + + ## Installing Multiple Kernels Apache Toree provides support for multiple languages. To enable this you need to install the configurations for these