mirror of
				https://github.com/alvierahman90/uploadr.git
				synced 2025-10-31 07:10:10 +00:00 
			
		
		
		
	Update README
This commit is contained in:
		
							
								
								
									
										19
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										19
									
								
								README.md
									
									
									
									
									
								
							| @@ -1,2 +1,21 @@ | |||||||
| # uploadr | # uploadr | ||||||
| Upload files to a server on your local network for faster and simpler file transfers across a network. | Upload files to a server on your local network for faster and simpler file transfers across a network. | ||||||
|  |  | ||||||
|  | ## config | ||||||
|  | The config file for uploadr is very simple. It should be in a class called  `uploadr` in a file called `config.py`. It should be valid python and the two options needed are `domain` and `port` which are both used for the creation of QR code links. The file can also be used as the config file for  | ||||||
|  | gunicorn. Here is an example below: | ||||||
|  | ```python | ||||||
|  | class uploadr: | ||||||
|  | 	domain = "example.com" | ||||||
|  | 	port = 8005 | ||||||
|  |  | ||||||
|  | # gunicorn | ||||||
|  | bind = "0.0.0.0:" + uploadr.port | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | ## dependencies | ||||||
|  | uploadr uses the following modules: | ||||||
|  |  - `flask` | ||||||
|  |  - `qrcode` | ||||||
|  |  - `werkzeug` | ||||||
|  |  | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user