mapmyaccess
v1.1.37
Published
mapmyaccess proxy to origin server
Downloads
88
Maintainers
Readme
MapMyAccess
MapMyAccess Proxy Local Setup Documentation
Requirements
- Before you install MapMyAccess, make sure that you have proper knowledge, hardware and operating system requirements.
- A Dedicated Server class machine with minimum of 8GB RAM and 20GB space.
- MapMyAccess is supported under two different operating systems: Linux and Windows.
- TCP ports 80 and 443 to be allowed from your network to the outside world.
- Software Node.js version 14 or higher installed on your system.
- Administrator access to the required folder where you want to install MapMyAccess Proxy services.
Installation Steps
1. Install Node.js 14+
Ensure you have Node.js version 14 or higher installed on your system. If Node.js is not installed, you can download it from the official website: Node.js
2. Verify Node.js Installation
To verify that Node.js has been installed successfully, open your command prompt (cmd) or terminal and run the following command:
node -v
If the command returns the installed Node.js version (14 or higher), then Node.js is installed correctly.
3. Download MapMyAccess Proxy Package
Open your command prompt (cmd) or terminal and navigate to the required folder where you want to install MapMyAccess Proxy. Then, run the following command to download the npm package:
npm i mapmyaccess
4. Verify Installation
Once the installation is complete, you should see a new folder named node_modules
in your chosen directory. This folder contains all the dependencies required by MapMyAccess Proxy.
5. Edit the Environment File
Navigate to the node_modules/mapmyaccess
folder using the command prompt (cmd) or terminal. Inside this folder, locate the env
file, and open it using a text editor.
In the env
file, make the following changes:
- Change the value of
ROOT_DOMAIN
to your choice of domain name. Replaceyour_domain.com
with your actual domain name. - Replace the value of
LIBRARY_KEY
with the key provided by MapSystems. Contact MapSystems support if you don't have the key.
Save the changes to the env
file.
6. Place Certificates in the Public Folder
In your chosen installation directory, locate the `public` folder. Inside the `public` folder, place your valid wild card SSL certificate key and certificate files with the following names:
- Certificate Key:
key.key
- Certificate File:
cer.cer
Make sure your wild card SSL certificate files are valid and match the requirements of your domain name.
Step 7: Navigate to MapMyAccess Folder
In your command prompt or terminal, navigate inside the "node_modules/mapmyaccess" folder:
cd node_modules/mapmyaccess
Step 8: Install PM2 Globally
Install PM2 globally using npm by running the following command:
npm install -g pm2
Step 9: Start PM2 Services
Start the PM2 services by running the following command:
pm2 start index.js
Congratulations! You have successfully set up MapMyAccess Proxy on your system. Now it is configured to manage access to your resources based on the specified domain name and library key.
If you encounter any issues or need further assistance, refer to the official documentation or contact MapSystems support.