Skip to content

Latest commit

 

History

History
58 lines (35 loc) · 5.04 KB

upload_and_connect.MD

File metadata and controls

58 lines (35 loc) · 5.04 KB

Uploading and Connecting Guide

######This guide contains a brief set of instructions for only certain problems. For a more in depth guide, in which you can learn more about what you are actually doing, visit "How to become a MediaWiki hacker"

SSH

This part of the guide contains information on connecting to you instance

Connecting to an Instance

Git, Gerrit, and GitHub

Git is a cooperative platform in which multiple software developers can ‘commit’ or make changes to the same existing code without destructive consequences. Gerrit is another code review platform in which software developers can upload their changes so that other developers can review to make sure that the code meets their expectations and standards. Finally GitHub is a repository where it is good practice to only upload working versions of code. This guide contains information on how to set up Git, using Git to commit to Gerrit, and how to keep your system updated.

Initial Setup for Git

Keeping your local repository updated

Committing to Gerrit

Check changes on gerrit

Squashing commits

Commiting to GitHub

DRMF-Specfic Information

The next section of the guide contains DRMF server specific information. It contains guides on how to download the current indexes, creating and starting both the servers used for the Math Search extension, and also information on how to import databases onto your instance.

Cloning Wikimedia

Retrieving the formula page indexes

Installing, Configuring, and Running MathWeb Search

Installing and Running BaseX Search

How to import the DRMF database to your DRMF instance

PHPStorm

Editing the files on the instance manually can be a hassle because editing directly on the instance is slow and there is no backup if mistakes are made. The last section involves installing and configuring the PHPStorm IDE so that it integrates a local and remote copy of your instance and automatically keeps them synchronized with each other, this way maintaining speed and a local backup.

Installing PHPStorm

Configuring PHPStorm

Installing PHP

Using PHPStorm to create a local server to test PHP files

In case PHPStorm is dysfunctional

Tips on How to avoid accidently sudoing on your local machine

###If you are working at NIST or for any other high security facility, chances are, you are not allowed to run commands as root via sudo However, a lot of the setting up and uploading and connecting in this guide requires you to sudo inside of ** your** instance. NOT THE LOCAL MACHINE!

I repeat, using sudo on a NIST computer can and will get you in a lot of trouble (I know from experience) so you cannot use it.

One way to avoid accidently sudoing in your machine when you meant to do it on your instance is to create an alias on your instance so that everytime you type in that alias the sudo command is actually being implement.

In my case, I made the alias for sudo be doit Follow this to make an alias on your instance that way you never have to type sudo both on your instance and your local machine but typing doit will act as a sudo alias only when you type it into your instance. Therefore if you accidently doit on your machine nothing will happen because no alias for doit exist.