Administrator Guide
Total Page:16
File Type:pdf, Size:1020Kb
MapleNet Administrator Guide Copyright © Maplesoft, a division of Waterloo Maple Inc. 2021 MapleNet Administrator Guide Copyright Maplesoft, MapleNet and Maple are all trademarks of Waterloo Maple Inc. © Maplesoft, a division of Waterloo Maple Inc. 2021. All rights reserved. No part of this book may be reproduced, stored in a retrieval system, or transcribed, in any form or by any means — electronic, mechanical, photo- copying, recording, or otherwise. Information in this document is subject to change without notice and does not represent a commitment on the part of the vendor. The software described in this document is furnished under a license agreement and may be used or copied only in accordance with the agreement. It is against the law to copy the software on any medium except as specifically allowed in the agreement. Oracle, Java and all Java-based marks are trademarks or registered trademarks of Oracle and/or its affiliates. Docker is a registered trademark of Docker, Inc. All other trademarks are the property of their respective owners. This document was produced using Maple and DocBook. Contents Overview .......................................................................................................................................... v 1 Introduction ..................................................................................................................................... 1 1.1 MapleNet .................................................................................................................................. 1 1.2 Docker Container for MapleNet ..................................................................................................... 1 2 Basics of Running MapleNet ............................................................................................................... 3 2.1 Glossary of Variables Used in This Chapter ..................................................................................... 3 2.2 Loading the MapleNet Docker Image ............................................................................................. 3 2.3 Starting MapleNet ...................................................................................................................... 3 Starting MapleNet Using the docker run Command ........................................................................... 3 Starting MapleNet Using a docker compose File ............................................................................... 4 Replacing the Landing Page .......................................................................................................... 4 2.4 Stopping MapleNet ..................................................................................................................... 4 2.5 Removing a Docker Image ........................................................................................................... 5 2.6 Adding Content to MapleNet ........................................................................................................ 5 2.7 MapleNet Logging ...................................................................................................................... 5 docker log ................................................................................................................................. 5 MapleNet options ....................................................................................................................... 5 3 Environment Variable Configuration ..................................................................................................... 7 3.1 Licensing .................................................................................................................................. 7 3.2 Directory Setup .......................................................................................................................... 7 3.3 Managing Connections ................................................................................................................ 7 3.4 Directory Listings ....................................................................................................................... 8 3.5 Sendfile Usage ........................................................................................................................... 8 3.6 Content Delivery Network ............................................................................................................ 8 3.7 Worksheet Template Location ....................................................................................................... 8 3.8 Web Server Endpoints ................................................................................................................. 8 Health Check Endpoints ............................................................................................................... 9 3.9 CORS ...................................................................................................................................... 9 3.10 SSL ...................................................................................................................................... 10 3.11 Client Configuration ................................................................................................................ 10 3.12 Managing Maple Engines ......................................................................................................... 11 3.13 Maple Configuration ................................................................................................................ 12 3.14 Configuring Logging ............................................................................................................... 12 3.15 Data Limit ............................................................................................................................. 13 3.16 Compute Engine ..................................................................................................................... 13 3.17 Document Engine .................................................................................................................... 14 4 Security Issues ................................................................................................................................ 15 4.1 Untrusted Users ........................................................................................................................ 15 4.2 Trusted Users ........................................................................................................................... 15 5 MapleNet Metrics and Monitoring ...................................................................................................... 17 5.1 Metrics and Monitoring Tools ..................................................................................................... 17 Health Check ........................................................................................................................... 17 Monitoring .............................................................................................................................. 18 Metrics over Prometheus ............................................................................................................ 19 6 Example Configurations ................................................................................................................... 23 6.1 Basic Document Hosting ............................................................................................................ 23 Mounting as a subdirectory of /webroot ......................................................................................... 23 Mounting on top of /webroot ....................................................................................................... 24 Using a Content Delivery Network for JavaScript libraries ................................................................ 24 Logging Configuration ............................................................................................................... 25 6.2 Basic Compute Hosting .............................................................................................................. 25 iii iv • Contents Cross-Origin Resource Sharing (CORS) ........................................................................................ 25 6.3 Adding Maple Libraries and Help Databases .................................................................................. 26 Changing the URL for the Help Database ...................................................................................... 26 6.4 Enabling the Upload Page ........................................................................................................... 27 6.5 Security Options ....................................................................................................................... 27 6.6 Troubleshooting ........................................................................................................................ 28 Docker not starting .................................................................................................................... 28 MapleNet is not starting ............................................................................................................. 28 Performances Issues .................................................................................................................. 29 7 Copyright .....................................................................................................................................