some changes

This commit is contained in:
Innubis 2021-11-17 11:39:53 -05:00
commit 5c7a8a2861
2 changed files with 42 additions and 6 deletions

40
Docs.md
View File

@ -3,36 +3,70 @@
## How to use ## How to use
You can use Instagram2Fedi via docker or just like a python script You can use Instagram2Fedi via docker or just like a python script
### Via Docker ### Via Docker 🐋
Specify your variables in `./env.sh` and then run `./run.sh` Specify your variables in `./env.sh` and then run `./run.sh`
You can modify `docker run` arguments in `./run.sh` You can modify `docker run` arguments in `./run.sh`
### Just a python script ### Just a python script 🐍
Run `pip3 install -r requirements.txt` and then run `./insta2fedi`. Run `pip3 install -r requirements.txt` and then run `./insta2fedi`.
Specify your arguments. You should use `--use-docker 0`. Specify your arguments. You should use `--use-docker 0`.
## Command line arguments For example:
``` bash
./insta2fedi --use-docker false --instagram-user <instagram username> --instance <instance domain> --token <OAuth token> --check-interval 10 --post-interval 10 --use-mastodon 4
# will check for new post each 10 seconds
```
## Command line arguments 🖥
`--use-mastodon` - set not positive number (`0`, `-1`...) if your instance don't have max image count limit. `--use-mastodon` - set not positive number (`0`, `-1`...) if your instance don't have max image count limit.
For example, default maximum photo count in mastodon is `4` For example, default maximum photo count in mastodon is `4`
---
`--instance` - Your instance url `--instance` - Your instance url
---
`--instagram-user` - Your instagram user name. `--instagram-user` - Your instagram user name.
---
`--token` - Your OAuth token `--token` - Your OAuth token
---
`--check-interval` - Interval in seconds how often to check for new posts `--check-interval` - Interval in seconds how often to check for new posts
---
`--post-interval` - Interval in seconds between posting new fetched posts. `--post-interval` - Interval in seconds between posting new fetched posts.
If theres more than one new post, sets with which time interval should it post them If theres more than one new post, sets with which time interval should it post them
---
`--fetch-count` - How many new posts to select `--fetch-count` - How many new posts to select
---
`--use-docker` - If you're running it via docker container, set to `1` or `True` `--use-docker` - If you're running it via docker container, set to `1` or `True`
## Default values ⚙
Default values are:
``` bash
--instance None
--instagram-user None
--token None
--check-interval 3600
--post-interval 3600
--fetch-count 10
--use-mastodon 4
--use-docker True
```

View File

@ -2,9 +2,13 @@
Simple python 🐍 script for crossposting from instagram to Mastodon/Pixelfed Simple python 🐍 script for crossposting from instagram to Mastodon/Pixelfed
## Installing ## Using without docker
See [Docs.md](./Docs.md)
## Using with Docker
Just clone repo, build a docker container and run it Just clone repo, build a docker container and run it
You can write all needed variables in `./env.sh` and then do `source ./run.sh`
``` bash ``` bash
git clone https://github.com/horhik/instagram2fedi git clone https://github.com/horhik/instagram2fedi
@ -13,8 +17,6 @@ docker build -t $YOUR_CONTAINER_NAME .
docker container run -it -d -v $(pwd):/app $YOUR_CONTAINER_NAME $I2M_INSTAGRAM_USER $I2M_INSTANCE $I2M_TOKEN docker container run -it -d -v $(pwd):/app $YOUR_CONTAINER_NAME $I2M_INSTAGRAM_USER $I2M_INSTANCE $I2M_TOKEN
``` ```
You can write all needed variables in `./env.sh` and then do `source ./run.sh`
![image](https://user-images.githubusercontent.com/46262811/131577640-a3103ff2-af37-422d-96f1-60f1acdef939.png) ![image](https://user-images.githubusercontent.com/46262811/131577640-a3103ff2-af37-422d-96f1-60f1acdef939.png)