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};
14 middleware::{self, ErrorHandlers},
20 use lemmy_api_common::{
21 context::LemmyContext,
22 lemmy_db_views::structs::SiteView,
23 request::build_user_agent,
25 check_private_instance_and_federation_enabled,
26 local_site_rate_limit_to_rate_limit_config,
29 use lemmy_apub::{VerifyUrlData, FEDERATION_HTTP_FETCH_LIMIT};
30 use lemmy_db_schema::{
31 source::secret::Secret,
32 utils::{build_db_pool, get_database_url, run_migrations},
34 use lemmy_routes::{feeds, images, nodeinfo, webfinger};
37 rate_limit::RateLimitCell,
38 response::jsonify_plain_text_errors,
40 SYNCHRONOUS_FEDERATION,
43 use reqwest_middleware::ClientBuilder;
44 use reqwest_tracing::TracingMiddleware;
45 use std::{env, thread, time::Duration};
46 use tracing::subscriber::set_global_default;
47 use tracing_actix_web::TracingLogger;
48 use tracing_error::ErrorLayer;
49 use tracing_log::LogTracer;
50 use tracing_subscriber::{filter::Targets, layer::SubscriberExt, Layer, Registry};
52 #[cfg(feature = "prometheus-metrics")]
54 actix_web_prom::PrometheusMetricsBuilder,
55 prometheus::default_registry,
56 prometheus_metrics::serve_prometheus,
59 /// Max timeout for http requests
60 pub(crate) const REQWEST_TIMEOUT: Duration = Duration::from_secs(10);
62 /// Placing the main function in lib.rs allows other crates to import it and embed Lemmy
63 pub async fn start_lemmy_server() -> Result<(), LemmyError> {
64 let args: Vec<String> = env::args().collect();
66 let scheduled_tasks_enabled = args.get(1) != Some(&"--disable-scheduled-tasks".to_string());
68 let settings = SETTINGS.to_owned();
70 // Run the DB migrations
71 let db_url = get_database_url(Some(&settings));
72 run_migrations(&db_url);
74 // Set up the connection pool
75 let pool = build_db_pool(&settings).await?;
77 // Run the Code-required migrations
78 run_advanced_migrations(&mut (&pool).into(), &settings).await?;
80 // Initialize the secrets
81 let secret = Secret::init(&mut (&pool).into())
83 .expect("Couldn't initialize secrets.");
85 // Make sure the local site is set up.
86 let site_view = SiteView::read_local(&mut (&pool).into())
88 .expect("local site not set up");
89 let local_site = site_view.local_site;
90 let federation_enabled = local_site.federation_enabled;
92 if federation_enabled {
93 println!("federation enabled, host is {}", &settings.hostname);
96 check_private_instance_and_federation_enabled(&local_site)?;
98 // Set up the rate limiter
99 let rate_limit_config =
100 local_site_rate_limit_to_rate_limit_config(&site_view.local_site_rate_limit);
101 let rate_limit_cell = RateLimitCell::new(rate_limit_config).await;
104 "Starting http server at {}:{}",
105 settings.bind, settings.port
108 let user_agent = build_user_agent(&settings);
109 let reqwest_client = Client::builder()
110 .user_agent(user_agent.clone())
111 .timeout(REQWEST_TIMEOUT)
112 .connect_timeout(REQWEST_TIMEOUT)
115 let client = ClientBuilder::new(reqwest_client.clone())
116 .with(TracingMiddleware::default())
119 // Pictrs cannot use the retry middleware
120 let pictrs_client = ClientBuilder::new(reqwest_client.clone())
121 .with(TracingMiddleware::default())
124 let context = LemmyContext::create(
128 rate_limit_cell.clone(),
131 if scheduled_tasks_enabled {
132 // Schedules various cleanup tasks for the DB
134 let context = context.clone();
136 scheduled_tasks::setup(db_url, user_agent, context)
137 .expect("Couldn't set up scheduled_tasks");
142 #[cfg(feature = "prometheus-metrics")]
143 serve_prometheus(settings.prometheus.as_ref(), context.clone());
145 let settings_bind = settings.clone();
147 let federation_config = FederationConfig::builder()
148 .domain(settings.hostname.clone())
149 .app_data(context.clone())
150 .client(client.clone())
151 .http_fetch_limit(FEDERATION_HTTP_FETCH_LIMIT)
152 .worker_count(settings.worker_count)
153 .retry_count(settings.retry_count)
154 .debug(*SYNCHRONOUS_FEDERATION)
155 .http_signature_compat(true)
156 .url_verifier(Box::new(VerifyUrlData(context.inner_pool().clone())))
160 // this must come before the HttpServer creation
161 // creates a middleware that populates http metrics for each path, method, and status code
162 #[cfg(feature = "prometheus-metrics")]
163 let prom_api_metrics = PrometheusMetricsBuilder::new("lemmy_api")
164 .registry(default_registry().clone())
168 // Create Http server with websocket support
169 HttpServer::new(move || {
170 let cors_origin = std::env::var("LEMMY_CORS_ORIGIN");
171 let cors_config = match (cors_origin, cfg!(debug_assertions)) {
172 (Ok(origin), false) => Cors::default()
173 .allowed_origin(&origin)
174 .allowed_origin(&settings.get_protocol_and_hostname()),
184 .wrap(middleware::Logger::new(
185 // 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
186 "%{r}a '%r' %s %b '%{Referer}i' '%{User-Agent}i' %T",
188 .wrap(middleware::Compress::default())
190 .wrap(TracingLogger::<QuieterRootSpanBuilder>::new())
191 .wrap(ErrorHandlers::new().default_handler(jsonify_plain_text_errors))
192 .app_data(Data::new(context.clone()))
193 .app_data(Data::new(rate_limit_cell.clone()))
194 .wrap(FederationMiddleware::new(federation_config.clone()));
196 #[cfg(feature = "prometheus-metrics")]
197 let app = app.wrap(prom_api_metrics.clone());
201 .configure(|cfg| api_routes_http::config(cfg, rate_limit_cell))
203 if federation_enabled {
204 lemmy_apub::http::routes::config(cfg);
205 webfinger::config(cfg);
208 .configure(feeds::config)
209 .configure(|cfg| images::config(cfg, pictrs_client.clone(), rate_limit_cell))
210 .configure(nodeinfo::config)
212 .bind((settings_bind.bind, settings_bind.port))?
219 pub fn init_logging(opentelemetry_url: &Option<Url>) -> Result<(), LemmyError> {
222 let log_description = std::env::var("RUST_LOG").unwrap_or_else(|_| "info".into());
224 let targets = log_description
227 .parse::<Targets>()?;
230 #[cfg(feature = "json-log")]
231 let layer = tracing_subscriber::fmt::layer().json();
232 #[cfg(not(feature = "json-log"))]
233 let layer = tracing_subscriber::fmt::layer();
235 layer.with_filter(targets.clone())
238 let subscriber = Registry::default()
240 .with(ErrorLayer::default());
242 if let Some(_url) = opentelemetry_url {
243 #[cfg(feature = "console")]
244 telemetry::init_tracing(_url.as_ref(), subscriber, targets)?;
245 #[cfg(not(feature = "console"))]
246 tracing::error!("Feature `console` must be enabled for opentelemetry tracing");
248 set_global_default(subscriber)?;