2. **Docker-composed** installed (if using Docker-compose) - [link](https://docs.docker.com/compose/install/)
88
+
3. **Credentials** configured - This can be done manually or by running the `make setup` command from the root of this repo
67
89
68
-
8. Run the main.py script
90
+
**Important**: Your container will fail if you do not do step #3 and configure your credentials
69
91
70
-
`python3 main.py <target username>`
92
+
### Docker
71
93
72
-
## Development version
94
+
If docker is installed you can build an image and run this as a container.
95
+
96
+
Build:
97
+
98
+
```bash
99
+
docker build -t osintgram .
100
+
```
101
+
102
+
Run:
103
+
104
+
```bash
105
+
docker run --rm -it -v "$PWD/output:/home/osintgram/output" osintgram <target>
106
+
```
107
+
108
+
- The `<target>` is the Instagram account you wish to use as your target for recon.
109
+
- The required `-i` flag enables an interactive terminal to use commands within the container. [docs](https://docs.docker.com/engine/reference/commandline/run/#assign-name-and-allocate-pseudo-tty---name--it)
110
+
- The required `-v` flag mounts a volume between your local filesystem and the container to save to the `./output/` folder. [docs](https://docs.docker.com/engine/reference/commandline/run/#mount-volume--v---read-only)
111
+
- The optional `--rm` flag removes the container filesystem on completion to prevent cruft build-up. [docs](https://docs.docker.com/engine/reference/run/#clean-up---rm)
112
+
- The optional `-t` flag allocates a pseudo-TTY which allows colored output. [docs](https://docs.docker.com/engine/reference/run/#foreground)
113
+
114
+
### Using `docker-compose`
115
+
116
+
You can use the `docker-compose.yml` file this single command:
117
+
118
+
```bash
119
+
docker-compose run osintgram <target>
120
+
```
121
+
122
+
Where `target` is the Instagram target for recon.
123
+
124
+
Alternatively you may run `docker-compose` with the `Makefile`:
125
+
126
+
`make run` - Builds and Runs with compose. Prompts for a `target` before running.
127
+
128
+
### Makefile (easy mode)
129
+
130
+
For ease of use with Docker-compose, a `Makefile` has been provided.
131
+
132
+
Here is a sample work flow to spin up a container and run `osintgram` with just two commands!
133
+
134
+
1. `make setup` - Sets up your Instagram credentials
135
+
2. `make run` - Builds and Runs a osintgram container and prompts for a target
136
+
137
+
Sample workflow for development:
138
+
139
+
1. `make setup` - Sets up your Instagram credentials
140
+
2. `make build-run-testing` - Builds an Runs a container without invoking the `main.py` script. Useful for an `it` Docker session for development
141
+
3. `make cleanup-testing` - Cleans up the testing container created from `build-run-testing`
142
+
143
+
## Development version 💻
144
+
73
145
To use the development version with the latest feature and fixes just switch to `development` branch using Git:
74
146
75
147
`git checkout development`
76
148
77
-
## Updating
149
+
## Updating⬇️
78
150
79
-
Run `git pull` in Osintgram directory
151
+
and update to last version using:
80
152
81
-
# Contributing
153
+
`git pull origin development`
154
+
155
+
## Contributing 💡
156
+
82
157
You can propose a feature request opening an issue or a pull request.
Giuseppe Criscione
committed
with
GitHub
3 years ago
