Skip to content
This repository was archived by the owner on Mar 11, 2026. It is now read-only.

Commit c149abc

Browse files
authored
Add note about code relocation to SimpleInstaBot
Updated README to reflect code relocation to SimpleInstaBot.
1 parent a564fc1 commit c149abc

File tree

1 file changed

+1
-97
lines changed

1 file changed

+1
-97
lines changed

README.md

Lines changed: 1 addition & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -4,100 +4,4 @@
44

55
instauto is an Instagram automation/bot library (API) written in TypeScript using Puppeteer. Goal is to be very easy to set up, use, and extend, and obey instagram's limits. Heavily inspired by [InstaPy](https://github.com/timgrossmann/InstaPy), but I thought it was way too heavy and hard to setup.
66

7-
There is also a GUI application for those who don't want to code: [SimpleInstaBot](https://mifi.github.io/SimpleInstaBot/)
8-
9-
## Setup
10-
11-
1. First install [Node.js](https://nodejs.org/en/)
12-
2. Create a new directory with a file like [example.ts](https://github.com/mifi/instauto/blob/master/example.ts)
13-
3. Adjust your `example.ts` to your needs. If you want to see how it would work without doing any invasive actions, use the `dryRun: true` option. Toggle `headless` to see it in action.
14-
15-
- Open a terminal in the directory
16-
17-
- Run `npm i -g yarn`
18-
19-
- Run `yarn add puppeteer instauto`
20-
21-
- Run `node example`
22-
23-
You can run this code for example once every day using cron or pm2 or similar
24-
25-
See [index.ts](https://github.com/mifi/instauto/blob/master/src/index.ts) for available options.
26-
27-
## Supported functionality
28-
29-
- Follow the followers of some particular users. (e.g. celebrities.) Parameters like max/min ratio for followers/following can be set.
30-
31-
- Unfollow users that don't follow us back. Will not unfollow any users that we recently followed.
32-
33-
- Unfollow auto followed users (also those following us back) after a certain number of days.
34-
35-
- The code automatically prevents breaching 100 follow/unfollows per hour or 700 per 24hr, to prevent bans. This can be configured.
36-
37-
See [example.ts](https://github.com/mifi/instauto/blob/master/example.ts) for example of features
38-
39-
## Tips
40-
- Run this on a machine with a non-cloud IP to avoid being banned
41-
42-
## Troubleshooting
43-
44-
- If it doesn't work, make sure your instagram language is set to english
45-
46-
## Running on Raspberry Pi
47-
48-
Because puppeteer chrome binaries are not provided for RPi, you need to first install chromium using apt.
49-
50-
Then replace your puppeteer launch code:
51-
52-
```js
53-
browser = await puppeteer.launch({
54-
executablePath: '/usr/bin/chromium-browser',
55-
headless: true,
56-
args: ['--disable-features=VizDisplayCompositor'],
57-
});
58-
```
59-
60-
See also:
61-
- https://github.com/GoogleChrome/puppeteer/issues/550
62-
- https://github.com/GoogleChrome/puppeteer/issues/3774
63-
64-
Also you might want to install the more lightweight package `puppeteer-core` instead of `puppeteer`.
65-
66-
## Running with pm2
67-
68-
First install [pm2](https://github.com/Unitech/pm2). (`npm i -g pm2`) Then copy [instabot.yml](https://github.com/mifi/instauto/blob/master/instabot.yml) into the same dir as `example.ts` and run:
69-
70-
```bash
71-
pm2 start instabot.yml
72-
pm2 save
73-
pm2 startup
74-
```
75-
76-
Now it will run automatically on reboot! 🙌
77-
78-
## Running in Docker
79-
80-
We've added a Docker support for instauto! In the **environment** section of your `docker-compose.yml` you need to specify your configuration for login and performance. If you want to raise another container, just copy the service with diff name and run the compose. You'll need to specify different ports.
81-
82-
```bash
83-
docker-compose --profile instauto up -d
84-
```
85-
86-
## Donate 🙈
87-
88-
This project is maintained by me alone. The project will always remain free and open source, but if it's useful for you, consider supporting me. :) It will give me extra motivation to improve it.
89-
90-
[Paypal](https://paypal.me/mifino/usd) | [crypto](https://mifi.no/thanks)
91-
92-
## Credits
93-
94-
- Icons made by [smalllikeart](https://www.flaticon.com/authors/smalllikeart) & [Freepik](https://www.flaticon.com/authors/freepik) from [www.flaticon.com](https://www.flaticon.com/)
95-
- Docker compose by https://github.com/maxxxdj
96-
97-
---
98-
99-
Made with ❤️ in 🇳🇴
100-
101-
[More apps by mifi.no](https://mifi.no/)
102-
103-
Follow me on [GitHub](https://github.com/mifi/), [YouTube](https://www.youtube.com/channel/UC6XlvVH63g0H54HSJubURQA), [IG](https://www.instagram.com/mifi.no/), [Twitter](https://twitter.com/mifi_no) for more awesome content!
7+
🚨 Note! Code has been moved here: [SimpleInstaBot/instauto](https://github.com/mifi/SimpleInstaBot/tree/master/packages/instauto).

0 commit comments

Comments
 (0)