captcha-igid/README.md

Authorization service for an intergalactic session

# Captcha IGID

**captcha-igid** is a [copious-transitions-apps](https://github.com/copious-world/copious-transition-apps) package. It handles authorization and basic contact procesing for user interactions based on Intergalactic Identities.

The npm page: [**captcha-igid**](https://www.npmjs.com/package/captcha-igid)

**captcha-igid** establishes a session and delivers a session token packet to calling web pages.

[copious-transitions](https://github.com/copious-world/copious-transitions) is a generalized framework for handling state transtitions from web clients as well as from [message-relay-services](https://www.npmjs.com/package/message-relay-services) endpoints. [copious-transitions-apps](https://github.com/copious-world/copious-transition-apps) are descendants of the ***CopiousTransitions*** class exported from [copious-transitions](https://github.com/copious-world/copious-transitions)

Intergalactic identities may be obtained on the of-this.world website. At the following address: [of-this.worldig/igid-creator/](https://www.of-this.world/igid-creator/)

## Installation

**captcha-igid** is an npm package: [**captcha-igid**](https://www.npmjs.com/package/captcha-igid)

The **captcha-igid** provides a bash command line which can be accessed if the package is installed globally as such:

```
npm install -g captcha-igid
```

This installation will create a script link in the ***bin*** directory configured for your npm. You should be able to confirm its installation with the following command:

```
which igid-auth
```


### running the program

The ***igid-auth*** program will run if a configuration file can be read from the working directory. If the working directory contains a configuration file with the name, **user-service-igid.conf** the program can be run by just entering the command name:

```
igid-auth
```

Otherwise, a configuration file must be specified:

```
igid-auth custom.conf
```

## Making connections

**igid-auth** may start up with default connections to databases and services. But, the connections may be set after it starts listening on all of its servers. 

The way to make custom connections to services (likely better than the defaults) is to make use of the tool, [**`com_link_manager`**](https://www.npmjs.com/package/com_link_manager). The tool can be installed on your system using npm as such:

```
npm install -g com_link_manager
```

Then, run this command with a configuration file name parameter (required).

```
com_link_manager link_construction_conf.conf
```

The configuration files for this tool are JSON formatted instructions telling the target program (running program) what classes to load, instantiate, and initialize.

Refer to [**`com_link_manager`**](https://www.npmjs.com/package/com_link_manager) for examples.

## Siblings

**captcha-igid** provides basic registration, login, and verification pathways. For a very simple application it can run by itself. But, most websites will have more operations for a user to do.

[copious-transitions-apps](https://github.com/copious-world/copious-transition-apps) provides a few other programs that can share session information managed by **captcha-igid**.

Here is a list of some other npm packages for running associated processes for uploading and asset access:

* [publication-igid](https://www.npmjs.com/package/publication-igid)
* [media-up-igid](https://www.npmjs.com/package/media-up-igid)
* [media-up-lite-igid](https://www.npmjs.com/package/media-up-lite-igid)
* [verify-session-backend](https://www.npmjs.com/package/verify-session-backend)
* [counter-access-igid](https://www.npmjs.com/package/counter-access-igid)