Skip to content

Commit 9ec82b9

Browse files
author
Kendar
committed
Added quick start link
1 parent 77dd78f commit 9ec82b9

File tree

4 files changed

+77
-1
lines changed

4 files changed

+77
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ errors can arise.
1111
The AnsweringMachine is built to overcome this troubles
1212

1313
* <b>Selenium automated runs :zap: for '[Record/replay db calls in integration tests!](docs/generated/dbtest.md)' and [Hacking google](docs/generated/googlehack.md) (with Selenium working unluckily on Win only)
14-
* <b>:zap: [Quick install](docs/gen_sources/quickinstall.md)</b>
14+
* <b>:zap: [Quick start](docs/generated/quickstart.md)</b>
1515
<br>
1616
<br>
1717

docs/gen_scripts/quickstart.bat

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
@echo off
2+
3+
cd %~dp0
4+
5+
set TARGET=..\generated\quickstart.md
6+
set SOURCE=..\gen_sources
7+
8+
type noedit.htm > %TARGET%
9+
echo In this demo you will >> %TARGET%
10+
type quickstart.md >> %TARGET%
11+
type %SOURCE%\quickinstall.md >> %TARGET%
12+
type %SOURCE%\proxy.md >> %TARGET%

docs/gen_scripts/quickstart.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2+
* Start locally HAM server
3+
* Connect to it through proxy
4+

docs/generated/quickstart.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
2+
<!--This file is autogenerated. Do not edit!-->
3+
In this demo you will
4+
5+
* Start locally HAM server
6+
* Connect to it through proxy
7+
8+
9+
## Download the last release<a id="quickinstall_01"></a>
10+
11+
Download the two tar.gz, ham and ham-samples from [github releases](https://github.com/kendarorg/HttpAnsweringMachine/releases)
12+
and extract them in the same directory
13+
14+
## Starting the sample application<a id="quickinstall_02"></a>
15+
16+
Go on the "calendar" directory and run "runcalendar.bat/sh"
17+
18+
This will start
19+
20+
* ham (localhost:80)
21+
* be (localhost:8100) proxied by http://localhost/int/be.sample.test
22+
* gateway (localhost:8090) proxied by http://localhost/int/gateway.sample.test
23+
* fe (localhost:8080)
24+
25+
<img src="../images/start_sample.gif" width="500"/>
26+
27+
## Configure proxy<a id="proxy_01"></a>
28+
29+
Should set the proxy to 127.0.0.1 And port 1080 for socks5 or 1081 for http/https
30+
31+
<details>
32+
<summary>Click me for more explanations</summary>
33+
34+
* Chrome:
35+
* Install [Proxy Switch Omega](https://chrome.google.com/webstore/detail/proxy-switchyomega/padekgcemlokbadohgkifijomclgjgif)
36+
* Go to options
37+
* Add http and https proxy server with
38+
* Address: 127.0.0.1
39+
* Port 1081.
40+
41+
<img alt="Ham Proxyes" src="../images/chrome_proxy.gif" width="500"/>
42+
* Select "proxy" from the extension menu and back to "direct" when you want to disconnect
43+
*
44+
<img alt="Ham Proxyes" src="../images/chrome_proxy_switch.gif" width="100"/>
45+
46+
* Firefox
47+
* Navigate to [about:preferences](about:preferences)
48+
* Search for "proxy"
49+
* Click on "Settings"
50+
* Go to "Manual proxy Configuration"
51+
* Select the socks5 proxy
52+
* Address: 127.0.0.1
53+
* Port 1080
54+
* Check the "Proxy DNS when using SOCKS v5" flag
55+
* Clean the settings when needed
56+
57+
<img alt="Ham Proxyes" src="../images/firefox_proxy.gif" width="500"/>
58+
59+
</details>
60+

0 commit comments

Comments
 (0)