trymonolith commited on
Commit
23a896d
·
verified ·
1 Parent(s): 1e955f1

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +48 -2
README.md CHANGED
@@ -1,10 +1,56 @@
1
  ---
2
  title: Postiz
3
- emoji: 📈
4
  colorFrom: indigo
5
  colorTo: green
6
  sdk: docker
7
  pinned: false
8
  ---
9
 
10
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  title: Postiz
3
+ emoji: 📨
4
  colorFrom: indigo
5
  colorTo: green
6
  sdk: docker
7
  pinned: false
8
  ---
9
 
10
+ # Postiz Self-Hosted on Hugging Face Spaces
11
+
12
+ This is a self-hosted deployment of [Postiz](https://postiz.com), an open-source social media scheduling and automation tool.
13
+
14
+ ## About Postiz
15
+
16
+ Postiz is a powerful all-in-one platform for social media management that allows you to:
17
+ - Schedule posts across multiple social media platforms
18
+ - Manage social media accounts efficiently
19
+ - Automate your social media workflows
20
+ - Analyze your content performance
21
+ - Integrate with AI for content generation
22
+
23
+ ## Getting Started
24
+
25
+ Once the Docker image builds successfully, Postiz will be available at the Space URL.
26
+
27
+ ## Important Notes
28
+
29
+ ### Database & Redis Requirements
30
+ Postiz requires PostgreSQL and Redis services to function properly. This deployment attempts to run Postiz, but full functionality may require:
31
+ - Setting up an external PostgreSQL database
32
+ - Configuring a Redis instance
33
+ - Updating environment variables with connection strings
34
+
35
+ ### Environment Configuration
36
+ Key environment variables that may need configuration:
37
+ - `DATABASE_URL`: PostgreSQL connection string
38
+ - `REDIS_URL`: Redis connection string
39
+ - `JWT_SECRET`: Secret for JWT token generation
40
+ - `APP_PORT`: Application port (default: 5000)
41
+
42
+ ## Resources
43
+
44
+ - [Postiz GitHub Repository](https://github.com/gitroomhq/postiz-app)
45
+ - [Postiz Documentation](https://docs.postiz.com)
46
+ - [Postiz Installation Guide](https://docs.postiz.com/installation/docker-compose)
47
+
48
+ ## For Production Use
49
+
50
+ For a production deployment, consider using:
51
+ - A dedicated VPS or cloud server
52
+ - Docker Compose with PostgreSQL and Redis services
53
+ - Proper SSL/TLS certificates
54
+ - Environment variable management with `.env` files
55
+
56
+ Refer to the official Postiz documentation for complete setup instructions.