1 pub mod api_routes_http;
2 pub mod code_migrations;
3 #[cfg(feature = "prometheus-metrics")]
4 pub mod prometheus_metrics;
5 pub mod root_span_builder;
6 pub mod scheduled_tasks;
7 #[cfg(feature = "console")]
10 use crate::{code_migrations::run_advanced_migrations, root_span_builder::QuieterRootSpanBuilder};
11 use activitypub_federation::config::{FederationConfig, FederationMiddleware};
13 use actix_web::{middleware, web::Data, App, HttpServer, Result};
14 use lemmy_api_common::{
15 context::LemmyContext,
16 lemmy_db_views::structs::SiteView,
17 request::build_user_agent,
19 check_private_instance_and_federation_enabled,
20 local_site_rate_limit_to_rate_limit_config,
23 use lemmy_apub::{VerifyUrlData, FEDERATION_HTTP_FETCH_LIMIT};
24 use lemmy_db_schema::{
25 source::secret::Secret,
26 utils::{build_db_pool, get_database_url, run_migrations},
28 use lemmy_routes::{feeds, images, nodeinfo, webfinger};
31 rate_limit::RateLimitCell,
33 SYNCHRONOUS_FEDERATION,
36 use reqwest_middleware::ClientBuilder;
37 use reqwest_tracing::TracingMiddleware;
38 use std::{env, thread, time::Duration};
39 use tracing::subscriber::set_global_default;
40 use tracing_actix_web::TracingLogger;
41 use tracing_error::ErrorLayer;
42 use tracing_log::LogTracer;
43 use tracing_subscriber::{filter::Targets, layer::SubscriberExt, Layer, Registry};
45 #[cfg(feature = "prometheus-metrics")]
47 actix_web_prom::PrometheusMetricsBuilder,
48 prometheus::default_registry,
49 prometheus_metrics::serve_prometheus,
52 /// Max timeout for http requests
53 pub(crate) const REQWEST_TIMEOUT: Duration = Duration::from_secs(10);
55 /// Placing the main function in lib.rs allows other crates to import it and embed Lemmy
56 pub async fn start_lemmy_server() -> Result<(), LemmyError> {
57 let args: Vec<String> = env::args().collect();
59 let scheduled_tasks_enabled = args.get(1) != Some(&"--disable-scheduled-tasks".to_string());
61 let settings = SETTINGS.to_owned();
63 // Run the DB migrations
64 let db_url = get_database_url(Some(&settings));
65 run_migrations(&db_url);
67 // Set up the connection pool
68 let pool = build_db_pool(&settings).await?;
70 // Run the Code-required migrations
71 run_advanced_migrations(&pool, &settings).await?;
73 // Initialize the secrets
74 let secret = Secret::init(&pool)
76 .expect("Couldn't initialize secrets.");
78 // Make sure the local site is set up.
79 let site_view = SiteView::read_local(&pool)
81 .expect("local site not set up");
82 let local_site = site_view.local_site;
83 let federation_enabled = local_site.federation_enabled;
85 if federation_enabled {
86 println!("federation enabled, host is {}", &settings.hostname);
89 check_private_instance_and_federation_enabled(&local_site)?;
91 // Set up the rate limiter
92 let rate_limit_config =
93 local_site_rate_limit_to_rate_limit_config(&site_view.local_site_rate_limit);
94 let rate_limit_cell = RateLimitCell::new(rate_limit_config).await;
97 "Starting http server at {}:{}",
98 settings.bind, settings.port
101 let user_agent = build_user_agent(&settings);
102 let reqwest_client = Client::builder()
103 .user_agent(user_agent.clone())
104 .timeout(REQWEST_TIMEOUT)
105 .connect_timeout(REQWEST_TIMEOUT)
108 let client = ClientBuilder::new(reqwest_client.clone())
109 .with(TracingMiddleware::default())
112 // Pictrs cannot use the retry middleware
113 let pictrs_client = ClientBuilder::new(reqwest_client.clone())
114 .with(TracingMiddleware::default())
117 let context = LemmyContext::create(
121 rate_limit_cell.clone(),
124 if scheduled_tasks_enabled {
125 // Schedules various cleanup tasks for the DB
127 let context = context.clone();
129 scheduled_tasks::setup(db_url, user_agent, context)
130 .expect("Couldn't set up scheduled_tasks");
135 #[cfg(feature = "prometheus-metrics")]
136 serve_prometheus(settings.prometheus.as_ref(), context.clone());
138 let settings_bind = settings.clone();
140 let federation_config = FederationConfig::builder()
141 .domain(settings.hostname.clone())
142 .app_data(context.clone())
143 .client(client.clone())
144 .http_fetch_limit(FEDERATION_HTTP_FETCH_LIMIT)
145 .worker_count(settings.worker_count)
146 .retry_count(settings.retry_count)
147 .debug(*SYNCHRONOUS_FEDERATION)
148 .http_signature_compat(true)
149 .url_verifier(Box::new(VerifyUrlData(context.pool().clone())))
153 // this must come before the HttpServer creation
154 // creates a middleware that populates http metrics for each path, method, and status code
155 #[cfg(feature = "prometheus-metrics")]
156 let prom_api_metrics = PrometheusMetricsBuilder::new("lemmy_api")
157 .registry(default_registry().clone())
161 // Create Http server with websocket support
162 HttpServer::new(move || {
163 let cors_origin = std::env::var("LEMMY_CORS_ORIGIN");
164 let cors_config = match (cors_origin, cfg!(debug_assertions)) {
165 (Ok(origin), false) => Cors::default()
166 .allowed_origin(&origin)
167 .allowed_origin(&settings.get_protocol_and_hostname()),
177 .wrap(middleware::Logger::new(
178 // This is the default log format save for the usage of %{r}a over %a to guarantee to record the client's (forwarded) IP and not the last peer address, since the latter is frequently just a reverse proxy
179 "%{r}a '%r' %s %b '%{Referer}i' '%{User-Agent}i' %T",
181 .wrap(middleware::Compress::default())
183 .wrap(TracingLogger::<QuieterRootSpanBuilder>::new())
184 .app_data(Data::new(context.clone()))
185 .app_data(Data::new(rate_limit_cell.clone()))
186 .wrap(FederationMiddleware::new(federation_config.clone()));
188 #[cfg(feature = "prometheus-metrics")]
189 let app = app.wrap(prom_api_metrics.clone());
193 .configure(|cfg| api_routes_http::config(cfg, rate_limit_cell))
195 if federation_enabled {
196 lemmy_apub::http::routes::config(cfg);
197 webfinger::config(cfg);
200 .configure(feeds::config)
201 .configure(|cfg| images::config(cfg, pictrs_client.clone(), rate_limit_cell))
202 .configure(nodeinfo::config)
204 .bind((settings_bind.bind, settings_bind.port))?
211 pub fn init_logging(opentelemetry_url: &Option<Url>) -> Result<(), LemmyError> {
214 let log_description = std::env::var("RUST_LOG").unwrap_or_else(|_| "info".into());
216 let targets = log_description
219 .parse::<Targets>()?;
222 #[cfg(feature = "json-log")]
223 let layer = tracing_subscriber::fmt::layer().json();
224 #[cfg(not(feature = "json-log"))]
225 let layer = tracing_subscriber::fmt::layer();
227 layer.with_filter(targets.clone())
230 let subscriber = Registry::default()
232 .with(ErrorLayer::default());
234 if let Some(_url) = opentelemetry_url {
235 #[cfg(feature = "console")]
236 telemetry::init_tracing(_url.as_ref(), subscriber, targets)?;
237 #[cfg(not(feature = "console"))]
238 tracing::error!("Feature `console` must be enabled for opentelemetry tracing");
240 set_global_default(subscriber)?;